Post x amz targetverifiedpermissions.createpolicy — verifiedpermissions

Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.

To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.

Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.

Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.

X-Amz-Target'VerifiedPermissions.CreatePolicy' required

Request body

clientTokenstring

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>. If you don't provide this value, then Amazon Web Services generates a random one for you. If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error. Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.

policyStoreIdstring required

Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy in. To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example: <ul> <li> ID: <code>PSEXAMPLEabcdefg111111</code> </li> <li> Alias name: <code>policy-store-alias/example-policy-store</code> </li> </ul> To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.

namestring

Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with <code>name/</code>. If you specify a name that is already associated with another policy in the policy store, you receive a <code>ConflictException</code> error.

Response

Success

policyStoreIdstring required

The ID of the policy store that contains the new policy.

policyIdstring required

The unique ID of the new policy.

policyType'STATIC' | 'TEMPLATE_LINKED' required

The policy type of the new policy.

createdDatestring date-time required

The date and time the policy was originally created.

lastUpdatedDatestring date-time required

The date and time the policy was last updated.

effect'Permit' | 'Forbid'

The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.

v1

Headers

Request body

Response