Get profile list

Prev Next

Available in Classic and VPC

Get the profile list.

Request

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

Method URI
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:

Field Type Required Description
searchColumn String Optional Search column
  • name | profileNrn
    • name: profile name
    • profileNrn: NAVER Cloud Platform resource identification value for profile
searchWord String Optional Search keyword
page Integer Optional Page number
  • 0-N (default: 0)
size Integer Optional Page 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'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
pageNo Integer - Page number
totalElements Integer - Number of response results
pageSize Integer - Page output count
content Array - Profile list

content

The following describes content.

Field Type Required Description
profileId String - Profile ID
profileNrn String - NAVER Cloud Platform resource identification value for profile
name String - Profile name
description String - Profile description
enabled Boolean - Status
  • true | false
    • true: enabled
    • false: disabled
durationSeconds Integer - Session expiration time
  • Temporary credential duration (second)
roleNrnList Array - List of roles mapped to profile
createTime String - Creation date and time
  • ISO 8601 format
updateTime String - 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"
        }
    ]
}