ユーザー定義ポリシーの存在有無の確認

Prev Next

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

対象アカウントにユーザー定義ポリシー(User Created)が存在するかどうかを確認します。

リクエスト

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

メソッド URI
GET /api/v1/assignments/exists-policy

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
accountMbrNo Integer Required アカウントの会員番号
permissionSetId String Required Permission Set ID

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/assignments/exists-policy?accountMbrNo=*******&permissionSetId=87512735-****-****-****-ab5b164127f5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - APIの処理結果
  • true | false
    • true: Permission Setに追加されたユーザー定義ポリシーは存在しないか、対象アカウントにユーザー定義ポリシーは存在
    • false: Permission Setに追加されたユーザー定義ポリシーは存在するが、対象アカウントにユーザー定義ポリシーは存在しない
message Array - 結果メッセージ
  • successがfalseの場合、表示

message

messageの説明は次の通りです。

フィールド タイプ 必須の有無 説明
userCreatedPolicyName String - ユーザー定義ポリシー(User Created)名

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

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

レスポンス例

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

ユーザー定義ポリシーが存在する場合

ユーザー定義ポリシーが存在する場合のレスポンスのサンプルコードは次の通りです。

{
    "success": true
}

ユーザー定義ポリシーが存在しない場合

ユーザー定義ポリシーが存在しない場合のレスポンスのサンプルコードは次の通りです。

{
  "success": false,
  "message": [
    {
      "userCreatedPolicyName": "policy010"
    }
  ]
}