MENU
      Get sub account list

        Get sub account list


        Article summary

        Available in Classic and VPC

        Get the sub account list.

        Request

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

        MethodURI
        GET/api/v1/sub-accounts

        Request headers

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

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        searchColumnStringOptionalSearch column
        • loginId | name | subAccountNo
          • loginId: Sub account login ID
          • name: Sub account name
          • subAccountNo: Sub account number
        searchWordStringOptionalSearch keyword
        pageIntegerOptionalPage number
        • 0-N (default: 0)
        sizeIntegerOptionalPage output count
        • 1-N (default: 10)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts' \
        --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
        pageInteger-Page number
        totalPagesInteger-Total number of pages
        totalItemsInteger-Number of response results
        hasPreviousBoolean-Whether previous page exists
        • true | false
          • true: It exists
          • false: It doesn't exist
        hasNextBoolean-Whether next page exists
        • true | false
          • true: It exists
          • false: It doesn't exist
        itemsArray-Sub account list
        isFirstBoolean-Whether it is the first page
        • true | false
          • true: first page
          • false: not a first page
        isLastBoolean-Whether it is the last page
        • true | false
          • true: last page
          • false: not a last page

        items

        The following describes items.

        FieldTypeRequiredDescription
        subAccountIdString-Sub account ID
        subAccountNoInteger-Sub account number
        loginIdString-Sub account login ID
        nameString-Sub account username
        emailString-Sub account user email address
        needPasswordResetBoolean-Sub account login password reset notification
        • Whether to notify to change password when logging in for the first time with a sub account
        • true | false
          • true: notify
          • false: do not notify
        canAPIGatewayAccessBoolean-API Gateway accessibility of the sub account
        • Whether to use APIs registered in API Gateway by creating an access key
        • true | false
          • true: available
          • false: unavailable
        canConsoleAccessBoolean-Whether the sub account can access the console
        • true | false
          • true: available
          • false: unavailable
        useConsolePermitIpBoolean-Whether the sub account's console access is restricted to a specific IP range
        • true | false
          • true: accessible only from the specified IP range
          • false: accessible from everywhere
        consolePermitIpsArray-List of IP ranges accessible to the console from the sub account
        useApiAllowSourceBoolean-Whether the accessible source for the API by the sub account is restricted
        • true | false
          • true: Accessible only from specified sources
          • false: Accessible from all sources
        apiAllowSourcesArray-List of sources accessible by sub account via API
        lastLoginTimeString-Sub account last login date and time
        • ISO 8601 format
        createTimeString-Sub account creation date and time
        • ISO 8601 format
        memoString-Sub account description
        activeBoolean-Sub account status
        • true | false
          • true: enabled
          • false: disabled
        modifiedTimeString-Sub account last modification date and time
        • ISO 8601 format
        nrnString-NAVER Cloud Platform resource identification value for sub account

        apiAllowSources

        The following describes apiAllowSources.

        FieldTypeRequiredDescription
        typeString-Access source type
        • IP | VPC | VPC_SERVER
          • IP: Single server IP or IP range including subnet
          • VPC: VPC in use
          • VPC_SERVER: Server in the VPC environment in use
        sourceString-Access source information
        • IP address or instance number

        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:

        {
            "page": 0,
            "totalPages": 1,
            "totalItems": 1,
            "hasPrevious": false,
            "hasNext": false,
            "items": [
                {
                    "subAccountId": "89b556d0-****-****-****-***********",
                    "subAccountNo": 16***,
                    "loginId": "h***",
                    "name": "h***",
                    "email": "l*****@*******.com",
                    "needPasswordReset": false,
                    "canAPIGatewayAccess": true,
                    "canConsoleAccess": true,
                    "useConsolePermitIp": true,
                    "consolePermitIps": [
                        "***.***.***.***"
                    ],
                    "useApiAllowSource": true,
                    "apiAllowSources": [
                        {
                            "type": "IP",
                            "source": "***.***.***.***"
                        }
                    ],
                    "lastLoginTime": "2025-01-01T23:48:07Z",
                    "createTime": "2024-09-30T04:57:47Z",
                    "memo": "",
                    "active": true,
                    "modifiedTime": "2024-12-23T02:56:29Z",
                    "nrn": "nrn:PUB:IAM::5*****8:SubAccount/89b556d0-****-****-****-***********"
                }
            ],
            "isFirst": true,
            "isLast": true
        }
        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.