Check existence of user created policy

Prev Next

Available in Classic and VPC

Check for the existence of a User Created policy in a target account.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/assignments/exists-policy

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
accountMbrNo Integer Required Account member ID
permissionSetId String Required Permission set ID

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result
  • true | false
    • true: The user created policy added to the permission set does not exist or the user created policy exists on the target account
    • false: There is a user created policy added to the permission set, but the target account does not have the user created policy
message Array - Result message
  • Displayed if success is false

message

The following describes message.

Field Type Required Description
userCreatedPolicyName String - User Created policy name

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The following is a sample response.

If user created policy exists

The following is a sample response if an user created policy exists.

{
    "success": true
}

If user created policy does not exist

The following is a sample response if an user created policy doesn't exist.

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