リクエスト

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

メソッド	URI
GET	/api/v1/permission-sets/{permissionSetId}/exists-policy

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`permissionSetId`	String	Required	Permission Set ID Permission Setリストの照会を参照

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

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

フィールド	タイプ	必須の有無	説明
`policyName`	String	Required	ユーザー定義ポリシー(User Created)名ポリシーリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/permission-sets/23ab7cb3-****-****-****-0b2222cb93e5/exists-policy?policyName=policy000' \
--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の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`accountName`	String	-	アカウントのユーザー名
`accountMbrNo`	Number	-	アカウントの会員番号(MemberNo)

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

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

レスポンス例

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

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

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

{
    "success": true
}

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

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

{
    "success": false,
    "message": [
        {
            "accountName": "田中太郎",
            "accountMbrNo": *******
        }
    ]
}

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

リクエスト
レスポンス