ロール状態の設定

Prev Next

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

ロールの状態を設定します。

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

リクエスト

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

メソッド URI
PUT /api/v1/roles​/{roleNo}/enable

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
roleNo String Required ロール ID

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

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

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

リクエスト例

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

curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/enable?active=true' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - API呼び出しに成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗

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

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

レスポンス例

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

{
    "success": true
}