Permission Setの更新

Prev Next

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

Permission Setの説明とポリシーを更新します。

リクエスト

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

メソッド URI
PUT /api/v1/permission-sets/{permissionSetId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
permissionSetId String Required Permission Set ID

リクエストボディ

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

フィールド タイプ 必須の有無 説明
description String Optional Permission Setの説明
  • 0~300文字
systemManagedPolicyIds Array Conditional マネージドポリシー(System Managed) IDリスト
  • マネージドポリシーリストの照会を参照
  • マネージドポリシーを設定する場合、必須
  • マネージドポリシーまたはユーザー定義ポリシーのうち1つ以上の入力が必要で、合計して最大10個まで追加可能
userCreatedPolicyNames Array Conditional ユーザー定義ポリシー(User Created)名リスト
  • ユーザー定義ポリシーを設定する場合、必須
  • マネージドポリシーまたはユーザー定義ポリシーのうち1つ以上の入力が必要で、合計して最大10個まで追加可能

リクエスト例

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

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/permission-sets/23ab7cb3-****-****-****-0b2222cb93e5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "description": "permissionset000 description",
    "systemManagedPolicyIds": [
        "3b773a30-****-****-****-246e96592200"
    ],
    "userCreatedPolicyNames": [
        "policy001"
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
id String - Permission Set ID
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successfalseの場合、表示

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

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

レスポンス例

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

{
    "id": "23ab7cb3-****-****-****-0b2222cb93e5",
    "success": true
}