Permission Set名のチェック

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

Permission Set名の有効性と重複チェックを行います。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/permission-sets/check-permission-set-name?permissionSetName=permissionset000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

チェックの結果、使用可能な名前の場合

チェックの結果、使用可能な名前の場合のレスポンスのサンプルコードは次の通りです。

{
    "name": "permissionset000",
    "success": true
}

チェックの結果、使用できない名前の場合

チェックの結果、使用できない名前の場合のレスポンスのサンプルコードは次の通りです。

• Permission Set名が既に存在する場合

  {
      "name": "permissionset000",
      "success": false,
      "message": "Permission set名が既に存在します。"
  }
  

• Permission Set名が有効でない場合

  {
      "success": false,
      "message": "2~30文字以内で入力してください。"
  }