Switch temporary credential roles

Available in Classic and VPC

Create temporary credentials with the role switched by granting the switchRole policy.

Request

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

Request headers

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

Request body

The following describes the body.

Request example

The request example is as follows:

curl --location --request POST 'https://sts.apigw.ntruss.com/api/v1/switch-role' \
--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' \
--data '{
	"roleNrn": "nrn:PUB:IAM::*****:Role/******************"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

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:

{
  "switchedRole": "nrn:PUB:IAM::*****:Role/******************",
  "credentials": {
    "accessKey": "ncp_iam_***************",
    "keySecret": "ncp_iam_**********************",
    "createTime": "2024-10-10T16:58:28Z",
    "expireTime": "2024-10-10T17:58:28Z",
    "useMfa": false
  }
}