切り替え可能なロールの登録

Prev Next

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

サブアカウントで切り替え可能なロールを登録します。 サブアカウントでのみ呼び出しできます。

参考

メインアカウントでサブアカウントに switchRoleポリシーを割り当てるとロールを切り替えできます。switchRoleポリシーを付与する方法は、Sub Accountご利用ガイドのswitchRoleポリシーの付与をご参照ください。

リクエスト

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

メソッド URI
POST /api/v1/switchable-roles

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
description String Optional ロールの説明(Bytes)
  • 0~300
displayName String Required ロール名
  • 3~30文字
roleNrn String Required ロール対する NAVERクラウドプラットフォームリソースの識別値
  • メインアカウントから渡された Accountロール情報を入力

リクエスト例

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

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/switchable-roles' \
--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' \
--header 'Content-Type: application/json' \
--data '{
    "description": "System admin",
    "displayName": "sys-admin",
    "roleNrn": "nrn:PUB:IAM::5*****8:Role/9ba09190-****-****-****-246e966ebec4"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - API呼び出しに成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗
id String - ロールに対する NAVERクラウドプラットフォームリソースの識別値

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

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

レスポンス例

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

{
  "success": true,
  "id": "nrn:PUB:IAM::5*****8:Role/9ba09190-****-****-****-246e966ebec4"
}