MENU
      Get subject list

        Get subject list


        Article summary

        Available in Classic and VPC

        Get the subject list.

        Request

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

        MethodURI
        GET/api/v1/subjects

        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
        • subjectId | subjectNrn
          • subjectId: subject ID
          • subjectNrn: NAVER Cloud Platform resource identification value for subject
        searchWordStringOptionalSearch keyword
        pageIntegerOptionalPage number
        • 0-N (default: 0)
        sizeIntegerOptionalPage output count
        • 1-N (default: 20)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://externalaccess.apigw.ntruss.com/api/v1/subjects?page=0&size=20' \
        --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
        pageNoInteger-Page number
        totalElementsInteger-Number of response results
        pageSizeInteger-Page output count
        contentArray-Subject list

        content

        The following describes content.

        FieldTypeRequiredDescription
        subjectIdString-Subject ID
        subjectNrnString-NAVER Cloud Platform resource identification value for subject
        x509SubjectString-Certificate's X.509 subject identifier
        enabledBoolean-Status
        • true | false
          • true: enabled
          • false: disabled
        createTimeString-Creation date and time
        • ISO 8601 format
        updateTimeString-Last modification date and time
        • ISO 8601 format
        lastSeenTimeString-Last usage date and time
        • ISO 8601 format

        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:

        {
            "pageNo": 0,
            "totalElements": 3,
            "pageSize": 20,
            "content": [
                {
                    "subjectId": "c2dea79b-****-****-****-c162618da17d",
                    "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/c2dea79b-****-****-****-c162618da17d",
                    "x509Subject": "CN=Real End cert simsiss, OU=IAM, O=Naver cloud, L=B, ST=A, C=KR",
                    "enabled": true,
                    "createTime": "2024-11-21T17:47:06.293+09:00",
                    "updateTime": "2024-12-12T18:09:05.7+09:00",
                    "lastSeenTime": "2024-12-12T18:09:05.699+09:00"
                },
                {
                    "subjectId": "c6c0bbdb-****-****-****-835d16999c7b",
                    "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/c6c0bbdb-****-****-****-835d16999c7b",
                    "x509Subject": "CN=End Cert simsiss, OU=IAM Service, O=NAVER Cloud Corp., L=Seongnam-si, ST=Gyeonggi-do, C=KR",
                    "enabled": true,
                    "createTime": "2024-10-17T19:38:35.591+09:00",
                    "updateTime": "2024-10-18T10:22:00.547+09:00",
                    "lastSeenTime": "2024-10-18T10:22:00.546+09:00"
                },
                {
                    "subjectId": "6812e8d3-****-****-****-85bab3480238",
                    "subjectNrn": "nrn:PUB:ExternalAccess::******:Subject/6812e8d3-****-****-****-85bab3480238",
                    "x509Subject": "CN=Mid - EndCert, OU=IAM Service, O=NAVER Cloud Corp., L=Seongnam-si, ST=Gyeonggi-do, C=KR",
                    "enabled": true,
                    "createTime": "2024-10-17T19:47:14.771+09:00",
                    "updateTime": "2024-10-17T19:47:14.771+09:00",
                    "lastSeenTime": "2024-10-17T19:47:14.739+09:00"
                }
            ]
        }
        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.