MENU
      Get profile list

        Get profile list


        Article summary

        Available in Classic and VPC

        Get the profile list.

        Request

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

        MethodURI
        GET/api/v1/profiles

        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
        • name | profileNrn
          • name: profile name
          • profileNrn: NAVER Cloud Platform resource identification value for profile
        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/profiles' \
        --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-Profile list

        content

        The following describes content.

        FieldTypeRequiredDescription
        profileIdString-Profile ID
        profileNrnString-NAVER Cloud Platform resource identification value for profile
        nameString-Profile name
        descriptionString-Profile description
        enabledBoolean-Status
        • true | false
          • true: enabled
          • false: disabled
        durationSecondsInteger-Session expiration time
        • Temporary credential duration (second)
        roleNrnListArray-List of roles mapped to profile
        createTimeString-Creation date and time
        • ISO 8601 format
        updateTimeString-Last modification 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": 1,
            "pageSize": 20,
            "content": [
                {
                    "profileId": "76da1a8c-****-****-****-cf13dfc49aa6",
                    "profileNrn": "nrn:PUB:ExternalAccess::*******:Profile/76da1a8c-****-****-****-cf13dfc49aa6",
                    "name": "profile000",
                    "description": "profile",
                    "enabled": true,
                    "durationSeconds": 600,
                    "roleNrnList": [],
                    "createTime": "2024-12-13T14:24:45.128+09:00",
                    "updateTime": "2024-12-13T14:24:45.128+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.