Check policy validity

Available in Classic and VPC

Check the validity of the policy details before creating a policy.

Request

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

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request body

You can include the following data in the body of your request:

permissions

The following describes permissions.

targets

The following describes targets.

Request example

The request example is as follows:

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/policy/48ac3260-****-****-****-246e96591594?withPermissions=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "policyName": "policy",
    "description": "Testing",
    "permissions": [
        {
            "effect": "Allow",
            "targets": [
                {
                    "product": "Server",
                    "actions": [
                        "View*"
                    ],
                    "resourceNrns": [
                        "*"
                    ]
                }
            ]
        }
    ]
}

Response

This section describes the response format.

Response body

The response body includes the following data:

details

The following describes details.

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

If the check results in a valid policy

The following is a sample response if the check results in a valid policy.

{
  "success": true
}

If the check results in an invalid policy

The following is a sample response if the check results in an invalid policy.

{
  "details": [
    {
      "type": "WARNING",
      "code": "iam.policy.missingRelatedAction",
      "location": "",
      "message": "An associated action is missing. {Server=[View/getInitScriptList, Change/changeInitScript, View/getRootPasswordServerInstanceList, Change/setDetailedMonitoring]}"
    }
  ],
  "success": false
}