切り替え可能なロールの照会

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

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

リクエスト

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

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

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Optional	検索カラム `nrn` \| `roleDisplayName` `nrn`: ロールに対する NAVERクラウドプラットフォームリソースの識別値 `roleDisplayName`: ロール名
`searchWord`	String	Optional	検索キーワード

リクエスト例

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

curl --location --request GET '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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`roleNo`	String	-	ロール ID
`roleNrn`	String	-	ロールに対する NAVERクラウドプラットフォームリソースの識別値
`displayName`	String	-	ロール名
`description`	String	-	ロールの説明
`isCurrentRole`	Boolean	-	現在使用中かどうか `true` \| `false` `true`: 使用中 `false`: 使用しない

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

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

レスポンス例

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

[
  {
    "roleNo": "9ba09190-****-****-****-246e966ebec4",
    "roleNrn": "nrn:PUB:IAM::5*****8:Role/9ba09190-****-****-****-246e966ebec4",
    "displayName": "Adm",
    "description": "admin",
    "isCurrentRole": false
  }
]