Get credentials

Prev Next

Available in Classic and VPC

Get temporary credentials (access key, secret key) for sub accounts created with Secure Token Service or get permanent access key for sub accounts and main account.

Note

See Create temporary credentials to learn how to use the Secure Token Service to create temporary credentials for sub accounts.

Request

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

Method URI
GET /api/v1/credentials

Request headers

For information about the headers common to all Secure Token Service APIs, see Secure Token Service request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://sts.apigw.ntruss.com/api/v1/credentials' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: 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
keySecret String - Secret key
  • Display when retrieving temporary credentials
createTime String - Creation date
  • ISO 8601 format
expireTime String - Expiration date
  • Display when retrieving temporary credentials
  • ISO 8601 format
useMfa Boolean - MFA authentication status
  • Display when retrieving temporary credentials
  • true | false
    • true: authenticated
    • false: not authenticated

Response status codes

For information about the HTTP status codes common to all Secure Token Service APIs, see Secure Token Service response status codes.

Response example

The response example is as follows:

{
    "accessKey": "ncp_iam_***************",
    "keySecret": "ncp_iam_**********************",
    "createTime": "2024-10-10T16:58:28Z",
    "expireTime": "2024-10-10T17:58:28Z",
    "useMfa": false
}