MENU
      Get user information

        Get user information


        Article summary

        Available in Classic and VPC

        Get the user information of sub accounts that has been granted permissions to an account, such as sub accounts, deleted sub accounts, or role users.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/v1/users/{subAccountId}

        Request headers

        For information about the headers common to all Sub Account APIs, see Sub Account request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        subAccountIdStringRequiredSub account ID

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        includeDeletedBooleanOptionalWhether to include deleted accounts
        • true | false (default)
          • true: include
          • false: exclude

        Request example

        The request example is as follows:

        curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/users/dfafe250-****-****-****-246e96591594?includeDeleted=true' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Accept: application/json'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        subAccountIdString-Sub account ID
        loginIdString-Sub account login ID
        nameString-Sub account username
        groupsArray-List of groups affiliated with sub account
        activeBoolean-Sub account status
        • true | false
          • true: enabled
          • false: disabled
        deletedBoolean-Whether it is a deleted account
        • true | false
          • true: deleted account
          • false: Undeleted account
        createTimeString-Sub account creation date and time
        • ISO 8601 format
        principalTypeString-Sub account type
        • IamUser | IamRole
          • IamUser: sub account
          • IamRole: role user
        sourceIdentityObject-Role user information
        • Display if principalType is IamRole
        sourceIdentity.typeString-Role user type
        • IamUser | Server | FederatedUser | NcloudService
          • IamUser: Account role
          • Server: Server role
          • FederatedUser: Single Sign-On role
          • NcloudService: Service role
        • Display if principalType is IamRole
        sourceIdentity.idString-Role user ID
        • Information displayed by role type
          • Account role: sub account ID
          • Server role: not applicable
          • Single Sign-On role: SSO user ID
          • Service role: service resource ID
        • Display if principalType is IamRole
        sourceIdentity.providerString-Role user's affiliation type
        • Information displayed by role type
          • Account role: member ID
          • Server role: not applicable
          • Single Sign-On role: SSO tenant ID
          • Service role: service ID
        • Display if principalType is IamRole
        roleNrnString-NAVER Cloud Platform resource identification value for the converted role
        • Display if principalType is IamRole

        groups

        The following describes groups.

        FieldTypeRequiredDescription
        groupIdString-Group ID
        groupNameString-Group name
        nrnString-NAVER Cloud Platform resource identification value for group

        Response status codes

        For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

        Response example

        The response example is as follows:

        {
            "subAccountId": "dfafe250-****-****-****-246e96591594",
            "loginId": "user000",
            "name": "user000",
            "groups": [
                {
                    "groupId": "50b77400-****-****-****-246e96591a38",
                    "groupName": "group002",
                    "nrn": "nrn:PUB:IAM::*******:Group/50b77400-****-****-****-246e96591a38"
                }
            ],
            "active": true,
            "deleted": false,
            "createTime": "2024-12-10T00:15:34Z",
            "principalType": "IamUser"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.