仮認証情報ロールの切り替え

Prev Next

Classic/VPC環境で利用できます。

switchRoleポリシーを付与して、ロールを切り替えた仮認証情報を作成します。

参考

ロール切り替えと switchRoleポリシーの詳細は、Sub Accountご利用ガイドのリシーとロール管理をご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/switch-role

リクエストヘッダ

Secure Token Service APIで共通して使用されるヘッダの詳細は、Secure Token Serviceのリクエストヘッダをご参照ください。

リクエストボディ

ボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
roleNrn String Required 切り替え後ロールの NRN
durationSec Integer Optional Access Keyの有効時間(秒)
  • 600~43200 (デフォルト: 3600)
serialNumber String Optional シリアル番号
  • OTPデバイス NRN | MFAシリアル番号
    • NAVERクラウドプラットフォームポータルのマイページ > アカウント管理 > セキュリティ設定メニューから確認可能
tokenCode Integer Optional OTP認証情報

リクエスト例

リクエストのサンプルコードは次の通りです。

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/******************"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
switchedRole String - 切り替え後ロールの NRN
credentials Object - ロール切り替えの結果
credentials.accessKey String - Access Key
credentials.keySecret String - Secret Key
credentials.createTime String - 作成日
  • ISO 8601形式
credentials.expireTime String - 有効期限
  • ISO 8601形式
credentials.useMfa Boolean - MFA認証を設定するかどうか
  • true | false
    • true: 設定する
    • false: 設定しない

レスポンスステータスコード

Secure Token Service APIで共通して使用されるレスポンスステータスコードの詳細は、Secure Token Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "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
  }
}