ロールリスト状態の設定

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

2つ以上のロール状態を設定します。

参考

Serverロールを無効化すると、Access Keyも無効化処理されます。
Accountロールを無効化すると、ロールが切り替えられたサブアカウントは自動ログアウトされ、Secure Token Service(STS)も期限切れします。
Single Sign-Onロールは Ncloud Single Sign-Onで無効化する必要があります。
Serviceロールを無効化すると、ロールが適用されたサービスアプリケーションが中断されることがあります。

リクエスト

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

メソッド	URI
PUT	/api/v1/roles

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`active`	Required	-	ロールの状態 `true` \| `false` `true`: 有効化 `false`: 無効化

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`roleNoList`	Array	Required	ロール IDリストロールリストの照会を参照

リクエスト例

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

curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/roles?active=false' \
--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 '[
    "5d0d4d80-****-****-****-246e96591a38",
    "d386b950-****-****-****-005056a7dc04"
]'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API呼び出しに成功したかどうか `true` \| `false` `true`: 成功 `false`: 失敗
`id`	String	-	ロール ID
`name`	String	-	アクションの種類

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

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

レスポンス例

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

[
    {
        "success": true,
        "id": "5d0d4d80-****-****-****-246e96591a38",
        "name": "enableRole"
    },
    {
        "success": true,
        "id": "d386b950-****-****-****-005056a7dc04",
        "name": "enableRole"
    }
]

この記事は役に立ちましたか?

リクエスト
レスポンス