Get access key

Prev Next

Available in Classic and VPC

Get the access key of a sub account.

Request

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

Method URI
GET /api/v1/sub-accounts/{subAccountId}/access-keys

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:

Field Type Required Description
subAccountId String Required Sub account ID

Request example

The request example is as follows:

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/access-keys' \
--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
accessKey String - Access Key
active Boolean - Sub account status
  • true | false
    • true: enabled
    • false: disabled
createTime String - Creation date and time

Request example

The request example is as follows:

curl --location --request GET 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/access-keys' \
--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
accessKey String - Access Key
active Boolean - Sub account status
  • true | false
    • true: enabled
    • false: disabled
createTime String - Creation 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:

[
  {
    "accessKey": "ncp_iam_BPASKR**************",
    "active": true,
    "createTime": "2024-12-20T02:52:04Z"
  },
  {
    "accessKey": "5908B****************",
    "active": true,
    "createTime": "2024-04-08T00:09:58Z"
  }
]