BatchGetPolicy

$result = $client->batchGetPolicy([/* ... */]);
$promise = $client->batchGetPolicyAsync([/* ... */]);

Retrieves information about a group (batch) of policies.

Parameter Syntax

$result = $client->batchGetPolicy([
    'requests' => [ // REQUIRED
        [
            'policyId' => '<string>', // REQUIRED
            'policyStoreId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => 'POLICY_STORE_NOT_FOUND|POLICY_NOT_FOUND',
            'message' => '<string>',
            'policyId' => '<string>',
            'policyStoreId' => '<string>',
        ],
        // ...
    ],
    'results' => [
        [
            'createdDate' => <DateTime>,
            'definition' => [
                'static' => [
                    'description' => '<string>',
                    'statement' => '<string>',
                ],
                'templateLinked' => [
                    'policyTemplateId' => '<string>',
                    'principal' => [
                        'entityId' => '<string>',
                        'entityType' => '<string>',
                    ],
                    'resource' => [
                        'entityId' => '<string>',
                        'entityType' => '<string>',
                    ],
                ],
            ],
            'lastUpdatedDate' => <DateTime>,
            'policyId' => '<string>',
            'policyStoreId' => '<string>',
            'policyType' => 'STATIC|TEMPLATE_LINKED',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To retrieve details about a policy

The following example retrieves information about the specified policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.

$result = $client->batchGetPolicy([
    'requests' => [
        [
            'policyId' => 'PWv5M6d5HePx3gVVLKY1nK',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
        ],
        [
            'policyId' => 'LzFn6KgLWvv4Mbegus35jn',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
        ],
        [
            'policyId' => '77gLjer8H5o3mvrnMGrSL5',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
        ],
    ],
]);

Result syntax:

[
    'errors' => [
    ],
    'results' => [
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'Users can manage account resources in any account they own',
                    'statement' => 'permit (principal, action in PhotoFlash::Action::"ManageAccount",resource) when { resource in principal.Account };',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => 'PWv5M6d5HePx3gVVLKY1nK',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
            'policyType' => 'STATIC',
        ],
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'User alice can't delete any photos.',
                    'statement' => 'forbid (principal == PhotoFlash::User::"alice", action in [PhotoFlash::Action::"DeletePhoto"], resource);',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => 'LzFn6KgLWvv4Mbegus35jn',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
            'policyType' => 'STATIC',
        ],
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'User alice can view and delete photos.',
                    'statement' => 'permit (principal == PhotoFlash::User::"alice", action in [PhotoFlash::Action::"DeletePhoto", PhotoFlash::Action::"ViewPhoto"], resource);',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => '77gLjer8H5o3mvrnMGrSL5',
            'policyStoreId' => 'ERZeDpRc34dkYZeb6FZRVC',
            'policyType' => 'STATIC',
        ],
    ],
]

BatchIsAuthorized

$result = $client->batchIsAuthorized([/* ... */]);
$promise = $client->batchIsAuthorizedAsync([/* ... */]);

Makes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an IsAuthorized request: principal, action, resource, and context. Either the principal or the resource parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where bob views photo1 and alice views photo2. Authorization of bob to view photo1 and photo2, or bob and alice to view photo1, are valid batches.

The request is evaluated against all policies in the specified policy store that match the entities that you declare. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.

The entities of a BatchIsAuthorized API request can contain up to 100 principals and up to 100 resources. The requests of a BatchIsAuthorized API request can contain up to 30 requests.

Parameter Syntax

$result = $client->batchIsAuthorized([
    'entities' => [
        'entityList' => [
            [
                'attributes' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
                'identifier' => [ // REQUIRED
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'parents' => [
                    [
                        'entityId' => '<string>', // REQUIRED
                        'entityType' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'policyStoreId' => '<string>', // REQUIRED
    'requests' => [ // REQUIRED
        [
            'action' => [
                'actionId' => '<string>', // REQUIRED
                'actionType' => '<string>', // REQUIRED
            ],
            'context' => [
                'contextMap' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
            ],
            'principal' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
            'resource' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'results' => [
        [
            'decision' => 'ALLOW|DENY',
            'determiningPolicies' => [
                [
                    'policyId' => '<string>',
                ],
                // ...
            ],
            'errors' => [
                [
                    'errorDescription' => '<string>',
                ],
                // ...
            ],
            'request' => [
                'action' => [
                    'actionId' => '<string>',
                    'actionType' => '<string>',
                ],
                'context' => [
                    'contextMap' => [
                        '<String>' => [
                            'boolean' => true || false,
                            'decimal' => '<string>',
                            'entityIdentifier' => [
                                'entityId' => '<string>',
                                'entityType' => '<string>',
                            ],
                            'ipaddr' => '<string>',
                            'long' => <integer>,
                            'record' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'set' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'string' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'principal' => [
                    'entityId' => '<string>',
                    'entityType' => '<string>',
                ],
                'resource' => [
                    'entityId' => '<string>',
                    'entityType' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: Batch - Example 1

The following example requests two authorization decisions for two principals of type Usernamed Alice and Annalisa.

$result = $client->batchIsAuthorized([
    'entities' => [
        'entityList' => [
            [
                'attributes' => [
                    'Account' => [
                        'entityIdentifier' => [
                            'entityId' => '1234',
                            'entityType' => 'PhotoFlash::Account',
                        ],
                    ],
                    'Email' => [
                        'string' => '',
                    ],
                ],
                'identifier' => [
                    'entityId' => 'Alice',
                    'entityType' => 'PhotoFlash::User',
                ],
                'parents' => [
                ],
            ],
            [
                'attributes' => [
                    'Account' => [
                        'entityIdentifier' => [
                            'entityId' => '5678',
                            'entityType' => 'PhotoFlash::Account',
                        ],
                    ],
                    'Email' => [
                        'string' => '',
                    ],
                ],
                'identifier' => [
                    'entityId' => 'Annalisa',
                    'entityType' => 'PhotoFlash::User',
                ],
                'parents' => [
                ],
            ],
            [
                'attributes' => [
                    'IsPrivate' => [
                        'boolean' => ,
                    ],
                    'Name' => [
                        'string' => '',
                    ],
                ],
                'identifier' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
                'parents' => [
                    [
                        'entityId' => '1234',
                        'entityType' => 'PhotoFlash::Account',
                    ],
                ],
            ],
            [
                'attributes' => [
                    'Name' => [
                        'string' => '',
                    ],
                ],
                'identifier' => [
                    'entityId' => '1234',
                    'entityType' => 'PhotoFlash::Account',
                ],
                'parents' => [
                ],
            ],
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'requests' => [
        [
            'action' => [
                'actionId' => 'ViewPhoto',
                'actionType' => 'PhotoFlash::Action',
            ],
            'principal' => [
                'entityId' => 'Alice',
                'entityType' => 'PhotoFlash::User',
            ],
            'resource' => [
                'entityId' => 'VacationPhoto94.jpg',
                'entityType' => 'PhotoFlash::Photo',
            ],
        ],
        [
            'action' => [
                'actionId' => 'DeletePhoto',
                'actionType' => 'PhotoFlash::Action',
            ],
            'principal' => [
                'entityId' => 'Annalisa',
                'entityType' => 'PhotoFlash::User',
            ],
            'resource' => [
                'entityId' => 'VacationPhoto94.jpg',
                'entityType' => 'PhotoFlash::Photo',
            ],
        ],
    ],
]);

Result syntax:

[
    'results' => [
        [
            'errors' => [
            ],
            'decision' => 'ALLOW',
            'determiningPolicies' => [
                [
                    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
                ],
            ],
            'request' => [
                'action' => [
                    'actionId' => 'ViewPhoto',
                    'actionType' => 'PhotoFlash::Action',
                ],
                'principal' => [
                    'entityId' => 'alice',
                    'entityType' => 'PhotoFlash::User',
                ],
                'resource' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
            ],
        ],
        [
            'errors' => [
            ],
            'decision' => 'DENY',
            'determiningPolicies' => [
            ],
            'request' => [
                'action' => [
                    'actionId' => 'DeletePhoto',
                    'actionType' => 'PhotoFlash::Action',
                ],
                'principal' => [
                    'entityId' => 'annalisa',
                    'entityType' => 'PhotoFlash::User',
                ],
                'resource' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
            ],
        ],
    ],
]

BatchIsAuthorizedWithToken

$result = $client->batchIsAuthorizedWithToken([/* ... */]);
$promise = $client->batchIsAuthorizedWithTokenAsync([/* ... */]);

Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.

The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declaration and in the token. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.

The entities of a BatchIsAuthorizedWithToken API request can contain up to 100 resources and up to 99 user groups. The requests of a BatchIsAuthorizedWithToken API request can contain up to 30 requests.

Parameter Syntax

$result = $client->batchIsAuthorizedWithToken([
    'accessToken' => '<string>',
    'entities' => [
        'entityList' => [
            [
                'attributes' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
                'identifier' => [ // REQUIRED
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'parents' => [
                    [
                        'entityId' => '<string>', // REQUIRED
                        'entityType' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'identityToken' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
    'requests' => [ // REQUIRED
        [
            'action' => [
                'actionId' => '<string>', // REQUIRED
                'actionType' => '<string>', // REQUIRED
            ],
            'context' => [
                'contextMap' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
            ],
            'resource' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'principal' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
    'results' => [
        [
            'decision' => 'ALLOW|DENY',
            'determiningPolicies' => [
                [
                    'policyId' => '<string>',
                ],
                // ...
            ],
            'errors' => [
                [
                    'errorDescription' => '<string>',
                ],
                // ...
            ],
            'request' => [
                'action' => [
                    'actionId' => '<string>',
                    'actionType' => '<string>',
                ],
                'context' => [
                    'contextMap' => [
                        '<String>' => [
                            'boolean' => true || false,
                            'decimal' => '<string>',
                            'entityIdentifier' => [
                                'entityId' => '<string>',
                                'entityType' => '<string>',
                            ],
                            'ipaddr' => '<string>',
                            'long' => <integer>,
                            'record' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'set' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'string' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'resource' => [
                    'entityId' => '<string>',
                    'entityType' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: Batch - Example 1

The following example requests three authorization decisions for two resources and two actions in different photo albums.

$result = $client->batchIsAuthorizedWithToken([
    'entities' => [
        'entityList' => [
            [
                'identifier' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
                'parents' => [
                    [
                        'entityId' => 'MyExampleAlbum1',
                        'entityType' => 'PhotoFlash::Album',
                    ],
                ],
            ],
            [
                'identifier' => [
                    'entityId' => 'OfficePhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
                'parents' => [
                    [
                        'entityId' => 'MyExampleAlbum2',
                        'entityType' => 'PhotoFlash::Album',
                    ],
                ],
            ],
        ],
    ],
    'identityToken' => 'eyJra12345EXAMPLE',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'requests' => [
        [
            'action' => [
                'actionId' => 'ViewPhoto',
                'actionType' => 'PhotoFlash::Action',
            ],
            'resource' => [
                'entityId' => 'VacationPhoto94.jpg',
                'entityType' => 'PhotoFlash::Photo',
            ],
        ],
        [
            'action' => [
                'actionId' => 'SharePhoto',
                'actionType' => 'PhotoFlash::Action',
            ],
            'resource' => [
                'entityId' => 'VacationPhoto94.jpg',
                'entityType' => 'PhotoFlash::Photo',
            ],
        ],
        [
            'action' => [
                'actionId' => 'ViewPhoto',
                'actionType' => 'PhotoFlash::Action',
            ],
            'resource' => [
                'entityId' => 'OfficePhoto94.jpg',
                'entityType' => 'PhotoFlash::Photo',
            ],
        ],
    ],
]);

Result syntax:

[
    'principal' => [
        'entityId' => 'us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
        'entityType' => 'PhotoFlash::User',
    ],
    'results' => [
        [
            'errors' => [
            ],
            'decision' => 'ALLOW',
            'determiningPolicies' => [
                [
                    'policyId' => '9wYixMplbbZQb5fcZHyJhY',
                ],
            ],
            'request' => [
                'action' => [
                    'actionId' => 'ViewPhoto',
                    'actionType' => 'PhotoFlash::Action',
                ],
                'resource' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
            ],
        ],
        [
            'errors' => [
            ],
            'decision' => 'ALLOW',
            'determiningPolicies' => [
                [
                    'policyId' => '9wYixMplbbZQb5fcZHyJhY',
                ],
            ],
            'request' => [
                'action' => [
                    'actionId' => 'SharePhoto',
                    'actionType' => 'PhotoFlash::Action',
                ],
                'resource' => [
                    'entityId' => 'VacationPhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
            ],
        ],
        [
            'errors' => [
            ],
            'decision' => 'DENY',
            'determiningPolicies' => [
            ],
            'request' => [
                'action' => [
                    'actionId' => 'ViewPhoto',
                    'actionType' => 'PhotoFlash::Action',
                ],
                'resource' => [
                    'entityId' => 'OfficePhoto94.jpg',
                    'entityType' => 'PhotoFlash::Photo',
                ],
            ],
        ],
    ],
]

CreateIdentitySource

$result = $client->createIdentitySource([/* ... */]);
$promise = $client->createIdentitySourceAsync([/* ... */]);

Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).

After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.

Parameter Syntax

$result = $client->createIdentitySource([
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
        'cognitoUserPoolConfiguration' => [
            'clientIds' => ['<string>', ...],
            'groupConfiguration' => [
                'groupEntityType' => '<string>', // REQUIRED
            ],
            'userPoolArn' => '<string>', // REQUIRED
        ],
        'openIdConnectConfiguration' => [
            'entityIdPrefix' => '<string>',
            'groupConfiguration' => [
                'groupClaim' => '<string>', // REQUIRED
                'groupEntityType' => '<string>', // REQUIRED
            ],
            'issuer' => '<string>', // REQUIRED
            'tokenSelection' => [ // REQUIRED
                'accessTokenOnly' => [
                    'audiences' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
                'identityTokenOnly' => [
                    'clientIds' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
            ],
        ],
    ],
    'policyStoreId' => '<string>', // REQUIRED
    'principalEntityType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'identitySourceId' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To create an identity source

The following ``create-identity-source`` example creates an identity source that lets you reference identities stored in the specified Amazon Cognito user pool. Those identities are available in Verified Permissions as entities of type ``User``.

$result = $client->createIdentitySource([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'configuration' => [
        'cognitoUserPoolConfiguration' => [
            'clientIds' => [
                'a1b2c3d4e5f6g7h8i9j0kalbmc',
            ],
            'userPoolArn' => 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5',
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'principalEntityType' => 'User',
]);

Result syntax:

[
    'createdDate' => ,
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]

CreatePolicy

$result = $client->createPolicy([/* ... */]);
$promise = $client->createPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createPolicy([
    'clientToken' => '<string>',
    'definition' => [ // REQUIRED
        'static' => [
            'description' => '<string>',
            'statement' => '<string>', // REQUIRED
        ],
        'templateLinked' => [
            'policyTemplateId' => '<string>', // REQUIRED
            'principal' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
            'resource' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
        ],
    ],
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actions' => [
        [
            'actionId' => '<string>',
            'actionType' => '<string>',
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'effect' => 'Permit|Forbid',
    'lastUpdatedDate' => <DateTime>,
    'policyId' => '<string>',
    'policyStoreId' => '<string>',
    'policyType' => 'STATIC|TEMPLATE_LINKED',
    'principal' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
    'resource' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To create a static policy

The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.

$result = $client->createPolicy([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'definition' => [
        'static' => [
            'description' => 'Grant members of janeFriends UserGroup access to the vacationFolder Album',
            'statement' => 'permit( principal in UserGroup::"janeFriends", action, resource in Album::"vacationFolder" );',
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyType' => 'STATIC',
    'principal' => [
        'entityId' => 'janeFriends',
        'entityType' => 'UserGroup',
    ],
    'resource' => [
        'entityId' => 'vacationFolder',
        'entityType' => 'Album',
    ],
]

Example 2: To create a static policy

The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.

$result = $client->createPolicy([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'definition' => [
        'static' => [
            'description' => 'Grant members of janeFriends UserGroup access to the vacationFolder Album',
            'statement' => 'permit( principal in UserGroup::"janeFriends", action, resource in Album::"vacationFolder" );',
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyType' => 'STATIC',
    'principal' => [
        'entityId' => 'janeFriends',
        'entityType' => 'UserGroup',
    ],
    'resource' => [
        'entityId' => 'vacationFolder',
        'entityType' => 'Album',
    ],
]

Example 3: To create a template-linked policy

The following example creates a template-linked policy using the specified policy template and associates the specified principal to use with the new template-linked policy.

$result = $client->createPolicy([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'definition' => [
        'templateLinked' => [
            'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
            'principal' => [
                'entityId' => 'alice',
                'entityType' => 'User',
            ],
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyId' => 'Et9KxMplyaDdyurDw8TeFa',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyType' => 'TEMPLATE_LINKED',
    'principal' => [
        'entityId' => 'alice',
        'entityType' => 'User',
    ],
    'resource' => [
        'entityId' => 'VacationPhoto94.jpg',
        'entityType' => 'Photo',
    ],
]

CreatePolicyStore

$result = $client->createPolicyStore([/* ... */]);
$promise = $client->createPolicyStoreAsync([/* ... */]);

Creates a policy store. A policy store is a container for policy resources.

Parameter Syntax

$result = $client->createPolicyStore([
    'clientToken' => '<string>',
    'description' => '<string>',
    'validationSettings' => [ // REQUIRED
        'mode' => 'OFF|STRICT', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To create policy store

The following example creates a new policy store with strict validation turned on.

$result = $client->createPolicyStore([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'validationSettings' => [
        'mode' => 'STRICT',
    ],
]);

Result syntax:

[
    'arn' => 'arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a',
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]

CreatePolicyTemplate

$result = $client->createPolicyTemplate([/* ... */]);
$promise = $client->createPolicyTemplateAsync([/* ... */]);

Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.

Parameter Syntax

$result = $client->createPolicyTemplate([
    'clientToken' => '<string>',
    'description' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
    'statement' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
    'policyTemplateId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To create a policy template

The following example creates a policy template that has a placeholder for the principal.

$result = $client->createPolicyTemplate([
    'clientToken' => 'a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111',
    'description' => 'Template for research dept',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'statement' => '"AccessVacation"permit( principal in ?principal, action == Action::"view", resource == Photo::"VacationPhoto94.jpg")when { principal has department && principal.department == "research"};',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
]

DeleteIdentitySource

$result = $client->deleteIdentitySource([/* ... */]);
$promise = $client->deleteIdentitySourceAsync([/* ... */]);

Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.

Parameter Syntax

$result = $client->deleteIdentitySource([
    'identitySourceId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To delete an identity source

The following example request deletes the specified identity source.

$result = $client->deleteIdentitySource([
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
]

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

Deletes the specified policy from the policy store.

This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful HTTP 200 status code.

Parameter Syntax

$result = $client->deletePolicy([
    'policyId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To delete a policy

The following example deletes the specified policy from its policy store.

$result = $client->deletePolicy([
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
]

DeletePolicyStore

$result = $client->deletePolicyStore([/* ... */]);
$promise = $client->deletePolicyStoreAsync([/* ... */]);

Deletes the specified policy store.

This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code.

Parameter Syntax

$result = $client->deletePolicyStore([
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To delete a policy store

The following example deletes the specified policy store.

$result = $client->deletePolicyStore([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
]

DeletePolicyTemplate

$result = $client->deletePolicyTemplate([/* ... */]);
$promise = $client->deletePolicyTemplateAsync([/* ... */]);

Deletes the specified policy template from the policy store.

Parameter Syntax

$result = $client->deletePolicyTemplate([
    'policyStoreId' => '<string>', // REQUIRED
    'policyTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To delete a policy template

The following example deletes a policy template. Before you can perform this operation, you must first delete any template-linked policies that were instantiated from this policy template. To delete them, use DeletePolicy.

$result = $client->deletePolicyTemplate([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
]);

Result syntax:

[
]

GetIdentitySource

$result = $client->getIdentitySource([/* ... */]);
$promise = $client->getIdentitySourceAsync([/* ... */]);

Retrieves the details about the specified identity source.

Parameter Syntax

$result = $client->getIdentitySource([
    'identitySourceId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        'cognitoUserPoolConfiguration' => [
            'clientIds' => ['<string>', ...],
            'groupConfiguration' => [
                'groupEntityType' => '<string>',
            ],
            'issuer' => '<string>',
            'userPoolArn' => '<string>',
        ],
        'openIdConnectConfiguration' => [
            'entityIdPrefix' => '<string>',
            'groupConfiguration' => [
                'groupClaim' => '<string>',
                'groupEntityType' => '<string>',
            ],
            'issuer' => '<string>',
            'tokenSelection' => [
                'accessTokenOnly' => [
                    'audiences' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
                'identityTokenOnly' => [
                    'clientIds' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
            ],
        ],
    ],
    'createdDate' => <DateTime>,
    'details' => [
        'clientIds' => ['<string>', ...],
        'discoveryUrl' => '<string>',
        'openIdIssuer' => 'COGNITO',
        'userPoolArn' => '<string>',
    ],
    'identitySourceId' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
    'principalEntityType' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To retrieve details about an identity source

The following example retrieves the details for the specified identity source.

$result = $client->getIdentitySource([
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'details' => [
        'clientIds' => [
            'a1b2c3d4e5f6g7h8i9j0kalbmc',
        ],
        'discoveryUrl' => 'https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5',
        'openIdIssuer' => 'COGNITO',
        'userPoolArn' => 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5',
    ],
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'principalEntityType' => 'AWS::Cognito',
]

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Retrieves information about the specified policy.

Parameter Syntax

$result = $client->getPolicy([
    'policyId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actions' => [
        [
            'actionId' => '<string>',
            'actionType' => '<string>',
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'definition' => [
        'static' => [
            'description' => '<string>',
            'statement' => '<string>',
        ],
        'templateLinked' => [
            'policyTemplateId' => '<string>',
            'principal' => [
                'entityId' => '<string>',
                'entityType' => '<string>',
            ],
            'resource' => [
                'entityId' => '<string>',
                'entityType' => '<string>',
            ],
        ],
    ],
    'effect' => 'Permit|Forbid',
    'lastUpdatedDate' => <DateTime>,
    'policyId' => '<string>',
    'policyStoreId' => '<string>',
    'policyType' => 'STATIC|TEMPLATE_LINKED',
    'principal' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
    'resource' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: To retrieve details about a policy

The following example retrieves information about the specified policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.

$result = $client->getPolicy([
    'policyId' => '9wYixMplbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'definition' => [
        'static' => [
            'description' => 'Grant everyone of janeFriends UserGroup access to the vacationFolder Album',
            'statement' => 'permit(principal, action, resource in Album::"publicFolder");',
        ],
    ],
    'lastUpdatedDate' => ,
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyType' => 'STATIC',
    'resource' => [
        'entityId' => 'publicFolder',
        'entityType' => 'Album',
    ],
]

GetPolicyStore

$result = $client->getPolicyStore([/* ... */]);
$promise = $client->getPolicyStoreAsync([/* ... */]);

Retrieves details about a policy store.

Parameter Syntax

$result = $client->getPolicyStore([
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
    'validationSettings' => [
        'mode' => 'OFF|STRICT',
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: GetPolicyStore

The following example retrieves details about the specified policy store.

$result = $client->getPolicyStore([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'arn' => 'arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a',
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'validationSettings' => [
        'mode' => 'STRICT',
    ],
]

GetPolicyTemplate

$result = $client->getPolicyTemplate([/* ... */]);
$promise = $client->getPolicyTemplateAsync([/* ... */]);

Retrieve the details for the specified policy template in the specified policy store.

Parameter Syntax

$result = $client->getPolicyTemplate([
    'policyStoreId' => '<string>', // REQUIRED
    'policyTemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
    'policyTemplateId' => '<string>',
    'statement' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: GetPolicyTemplate

The following example displays the details of the specified policy template.

$result = $client->getPolicyTemplate([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
]);

Result syntax:

[
    'createdDate' => ,
    'description' => 'Template for research dept',
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
    'statement' => 'permit( principal ?principal, action == Action::"view", resource in ?resource) when { principal has department && principal.department == "research"};',
]

GetSchema

$result = $client->getSchema([/* ... */]);
$promise = $client->getSchemaAsync([/* ... */]);

Retrieve the details for the specified schema in the specified policy store.

Parameter Syntax

$result = $client->getSchema([
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'namespaces' => ['<string>', ...],
    'policyStoreId' => '<string>',
    'schema' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: GetSchema

The following example retrieves the current schema stored in the specified policy store.NoteThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.

$result = $client->getSchema([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'schema' => '{"My::Application": {"actions": {"remoteAccess": {"appliesTo": {"principalTypes": ["Employee"]}}},"entityTypes": {"Employee": {"shape": {"attributes": {"jobLevel": { "type": "Long" },"name": { "type":"String" }},"type": "Record"}}}} }',
]

IsAuthorized

$result = $client->isAuthorized([/* ... */]);
$promise = $client->isAuthorizedAsync([/* ... */]);

Makes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

Parameter Syntax

$result = $client->isAuthorized([
    'action' => [
        'actionId' => '<string>', // REQUIRED
        'actionType' => '<string>', // REQUIRED
    ],
    'context' => [
        'contextMap' => [
            '<String>' => [
                'boolean' => true || false,
                'decimal' => '<string>',
                'entityIdentifier' => [
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'ipaddr' => '<string>',
                'long' => <integer>,
                'record' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'set' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'string' => '<string>',
            ],
            // ...
        ],
    ],
    'entities' => [
        'entityList' => [
            [
                'attributes' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
                'identifier' => [ // REQUIRED
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'parents' => [
                    [
                        'entityId' => '<string>', // REQUIRED
                        'entityType' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'policyStoreId' => '<string>', // REQUIRED
    'principal' => [
        'entityId' => '<string>', // REQUIRED
        'entityType' => '<string>', // REQUIRED
    ],
    'resource' => [
        'entityId' => '<string>', // REQUIRED
        'entityType' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'decision' => 'ALLOW|DENY',
    'determiningPolicies' => [
        [
            'policyId' => '<string>',
        ],
        // ...
    ],
    'errors' => [
        [
            'errorDescription' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: IsAuthorized - Example 1

The following example requests an authorization decision for a principal of type User named Alice, who wants to perform the updatePhoto operation, on a resource of type Photo named VacationPhoto94.jpg.The response shows that the request was allowed by one policy.

$result = $client->isAuthorized([
    'action' => [
        'actionId' => 'view',
        'actionType' => 'Action',
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'principal' => [
        'entityId' => 'alice',
        'entityType' => 'User',
    ],
    'resource' => [
        'entityId' => 'VacationPhoto94.jpg',
        'entityType' => 'Photo',
    ],
]);

Result syntax:

[
    'errors' => [
    ],
    'decision' => 'ALLOW',
    'determiningPolicies' => [
        [
            'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
        ],
    ],
]

Example 2: IsAuthorized - Example 2

The following example is the same as the previous example, except that the principal is User::"bob", and the policy store doesn't contain any policy that allows that user access to Album::"alice_folder". The output infers that the Deny was implicit because the list of DeterminingPolicies is empty.

$result = $client->isAuthorized([
    'action' => [
        'actionId' => 'view',
        'actionType' => 'Action',
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'principal' => [
        'entityId' => 'bob',
        'entityType' => 'User',
    ],
    'resource' => [
        'entityId' => 'VacationPhoto94.jpg',
        'entityType' => 'Photo',
    ],
]);

Result syntax:

[
    'errors' => [
    ],
    'decision' => 'DENY',
    'determiningPolicies' => [
    ],
]

IsAuthorizedWithToken

$result = $client->isAuthorizedWithToken([/* ... */]);
$promise = $client->isAuthorizedWithTokenAsync([/* ... */]);

Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.

Parameter Syntax

$result = $client->isAuthorizedWithToken([
    'accessToken' => '<string>',
    'action' => [
        'actionId' => '<string>', // REQUIRED
        'actionType' => '<string>', // REQUIRED
    ],
    'context' => [
        'contextMap' => [
            '<String>' => [
                'boolean' => true || false,
                'decimal' => '<string>',
                'entityIdentifier' => [
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'ipaddr' => '<string>',
                'long' => <integer>,
                'record' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'set' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'string' => '<string>',
            ],
            // ...
        ],
    ],
    'entities' => [
        'entityList' => [
            [
                'attributes' => [
                    '<String>' => [
                        'boolean' => true || false,
                        'decimal' => '<string>',
                        'entityIdentifier' => [
                            'entityId' => '<string>', // REQUIRED
                            'entityType' => '<string>', // REQUIRED
                        ],
                        'ipaddr' => '<string>',
                        'long' => <integer>,
                        'record' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'set' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'string' => '<string>',
                    ],
                    // ...
                ],
                'identifier' => [ // REQUIRED
                    'entityId' => '<string>', // REQUIRED
                    'entityType' => '<string>', // REQUIRED
                ],
                'parents' => [
                    [
                        'entityId' => '<string>', // REQUIRED
                        'entityType' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'identityToken' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
    'resource' => [
        'entityId' => '<string>', // REQUIRED
        'entityType' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'decision' => 'ALLOW|DENY',
    'determiningPolicies' => [
        [
            'policyId' => '<string>',
        ],
        // ...
    ],
    'errors' => [
        [
            'errorDescription' => '<string>',
        ],
        // ...
    ],
    'principal' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: IsAuthorizedWithToken - Example 1

The following example requests an authorization decision for a user who was authenticated by Amazon Cognito. The request uses the identity token provided by Amazon Cognito instead of the access token. In this example, the specified information store is configured to return principals as entities of type CognitoUser. The policy store contains a policy with the following statement.permit( principal == CognitoUser::"us-east-1_1a2b3c4d5|a1b2c3d4e5f6g7h8i9j0kalbmc", action, resource == Photo::"VacationPhoto94.jpg");

$result = $client->isAuthorizedWithToken([
    'action' => [
        'actionId' => 'View',
        'actionType' => 'Action',
    ],
    'identityToken' => 'EgZjxMPlbWUyBggAEEUYOdIBCDM3NDlqMGo3qAIAsAIA',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'resource' => [
        'entityId' => 'vacationPhoto94.jpg',
        'entityType' => 'Photo',
    ],
]);

Result syntax:

[
    'errors' => [
    ],
    'decision' => 'ALLOW',
    'determiningPolicies' => [
        [
            'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
        ],
    ],
]

ListIdentitySources

$result = $client->listIdentitySources([/* ... */]);
$promise = $client->listIdentitySourcesAsync([/* ... */]);

Returns a paginated list of all of the identity sources defined in the specified policy store.

Parameter Syntax

$result = $client->listIdentitySources([
    'filters' => [
        [
            'principalEntityType' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'identitySources' => [
        [
            'configuration' => [
                'cognitoUserPoolConfiguration' => [
                    'clientIds' => ['<string>', ...],
                    'groupConfiguration' => [
                        'groupEntityType' => '<string>',
                    ],
                    'issuer' => '<string>',
                    'userPoolArn' => '<string>',
                ],
                'openIdConnectConfiguration' => [
                    'entityIdPrefix' => '<string>',
                    'groupConfiguration' => [
                        'groupClaim' => '<string>',
                        'groupEntityType' => '<string>',
                    ],
                    'issuer' => '<string>',
                    'tokenSelection' => [
                        'accessTokenOnly' => [
                            'audiences' => ['<string>', ...],
                            'principalIdClaim' => '<string>',
                        ],
                        'identityTokenOnly' => [
                            'clientIds' => ['<string>', ...],
                            'principalIdClaim' => '<string>',
                        ],
                    ],
                ],
            ],
            'createdDate' => <DateTime>,
            'details' => [
                'clientIds' => ['<string>', ...],
                'discoveryUrl' => '<string>',
                'openIdIssuer' => 'COGNITO',
                'userPoolArn' => '<string>',
            ],
            'identitySourceId' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'policyStoreId' => '<string>',
            'principalEntityType' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: ListIdentitySources

The following example request creates lists the identity sources currently defined in the specified policy store.

$result = $client->listIdentitySources([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'identitySources' => [
        [
            'createdDate' => ,
            'details' => [
                'clientIds' => [
                    'a1b2c3d4e5f6g7h8i9j0kalbmc',
                ],
                'discoveryUrl' => 'https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5',
                'openIdIssuer' => 'COGNITO',
                'userPoolArn' => 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5',
            ],
            'identitySourceId' => 'ISEXAMPLEabcdefg111111',
            'lastUpdatedDate' => ,
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'principalEntityType' => 'User',
        ],
    ],
]

ListPolicies

$result = $client->listPolicies([/* ... */]);
$promise = $client->listPoliciesAsync([/* ... */]);

Returns a paginated list of all policies stored in the specified policy store.

Parameter Syntax

$result = $client->listPolicies([
    'filter' => [
        'policyTemplateId' => '<string>',
        'policyType' => 'STATIC|TEMPLATE_LINKED',
        'principal' => [
            'identifier' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
            'unspecified' => true || false,
        ],
        'resource' => [
            'identifier' => [
                'entityId' => '<string>', // REQUIRED
                'entityType' => '<string>', // REQUIRED
            ],
            'unspecified' => true || false,
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'policies' => [
        [
            'actions' => [
                [
                    'actionId' => '<string>',
                    'actionType' => '<string>',
                ],
                // ...
            ],
            'createdDate' => <DateTime>,
            'definition' => [
                'static' => [
                    'description' => '<string>',
                ],
                'templateLinked' => [
                    'policyTemplateId' => '<string>',
                    'principal' => [
                        'entityId' => '<string>',
                        'entityType' => '<string>',
                    ],
                    'resource' => [
                        'entityId' => '<string>',
                        'entityType' => '<string>',
                    ],
                ],
            ],
            'effect' => 'Permit|Forbid',
            'lastUpdatedDate' => <DateTime>,
            'policyId' => '<string>',
            'policyStoreId' => '<string>',
            'policyType' => 'STATIC|TEMPLATE_LINKED',
            'principal' => [
                'entityId' => '<string>',
                'entityType' => '<string>',
            ],
            'resource' => [
                'entityId' => '<string>',
                'entityType' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: ListPolicies - Example 1

The following example lists all policies in the policy store.

$result = $client->listPolicies([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'policies' => [
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'Grant members of janeFriends UserGroup access to the vacationFolder Album',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyType' => 'STATIC',
            'principal' => [
                'entityId' => 'janeFriends',
                'entityType' => 'UserGroup',
            ],
            'resource' => [
                'entityId' => 'vacationFolder',
                'entityType' => 'Album',
            ],
        ],
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'Grant everyone access to the publicFolder Album',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => 'Et9KxMplyaDdyurDw8TeFa',
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyType' => 'STATIC',
            'resource' => [
                'entityId' => 'publicFolder',
                'entityType' => 'Album',
            ],
        ],
    ],
]

Example 2: ListPolicies - Example 2

The following example lists all policies for a specified principal.

$result = $client->listPolicies([
    'filter' => [
        'principal' => [
            'identifier' => [
                'entityId' => 'alice',
                'entityType' => 'User',
            ],
        ],
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'policies' => [
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                    'description' => 'An example policy',
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => 'Et9KxMplyaDdyurDw8TeFa',
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyType' => 'STATIC',
            'principal' => [
                'entityId' => 'alice',
                'entityType' => 'User',
            ],
            'resource' => [
                'entityId' => 'bob_folder',
                'entityType' => 'Album',
            ],
        ],
        [
            'createdDate' => ,
            'definition' => [
                'static' => [
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyType' => 'STATIC',
            'principal' => [
                'entityId' => 'alice',
                'entityType' => 'User',
            ],
            'resource' => [
                'entityId' => 'alice_folder',
                'entityType' => 'Album',
            ],
        ],
    ],
]

Example 3: ListPolicies - Example 3

The following example uses the Filter parameter to list only the template-linked policies in the specified policy store.

$result = $client->listPolicies([
    'filter' => [
        'policyType' => 'TEMPLATE_LINKED',
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'policies' => [
        [
            'createdDate' => ,
            'definition' => [
                'templateLinked' => [
                    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
                    'principal' => [
                        'entityId' => 'alice',
                        'entityType' => 'User',
                    ],
                    'resource' => [
                        'entityId' => 'pic.jpg',
                        'entityType' => 'Photo',
                    ],
                ],
            ],
            'lastUpdatedDate' => ,
            'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyType' => 'TEMPLATE_LINKED',
            'principal' => [
                'entityId' => 'alice',
                'entityType' => 'User',
            ],
            'resource' => [
                'entityId' => 'pic.jpg',
                'entityType' => 'Photo',
            ],
        ],
    ],
]

ListPolicyStores

$result = $client->listPolicyStores([/* ... */]);
$promise = $client->listPolicyStoresAsync([/* ... */]);

Returns a paginated list of all policy stores in the calling Amazon Web Services account.

Parameter Syntax

$result = $client->listPolicyStores([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'policyStores' => [
        [
            'arn' => '<string>',
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'policyStoreId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: ListPolicyStores

The following example lists all policy stores in the AWS account in the AWS Region in which you call the operation.

$result = $client->listPolicyStores([
]);

Result syntax:

[
    'policyStores' => [
        [
            'arn' => 'arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a',
            'createdDate' => ,
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
        ],
        [
            'arn' => 'arn:aws:verifiedpermissions::123456789012:policy-store/PSEXAMPLEabcdefg222222',
            'createdDate' => ,
            'policyStoreId' => 'PSEXAMPLEabcdefg222222',
        ],
    ],
]

ListPolicyTemplates

$result = $client->listPolicyTemplates([/* ... */]);
$promise = $client->listPolicyTemplatesAsync([/* ... */]);

Returns a paginated list of all policy templates in the specified policy store.

Parameter Syntax

$result = $client->listPolicyTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'policyTemplates' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'policyStoreId' => '<string>',
            'policyTemplateId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: ListPolicyTemplates

The following example retrieves a list of all of the policy templates in the specified policy store.

$result = $client->listPolicyTemplates([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'policyTemplates' => [
        [
            'createdDate' => ,
            'description' => 'Generic template',
            'lastUpdatedDate' => ,
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
        ],
        [
            'createdDate' => ,
            'description' => 'Template for research dept',
            'lastUpdatedDate' => ,
            'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
            'policyTemplateId' => 'PTEXAMPLEabcdefg222222',
        ],
    ],
]

PutSchema

$result = $client->putSchema([/* ... */]);
$promise = $client->putSchemaAsync([/* ... */]);

Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.

Parameter Syntax

$result = $client->putSchema([
    'definition' => [ // REQUIRED
        'cedarJson' => '<string>',
    ],
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'namespaces' => ['<string>', ...],
    'policyStoreId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: PutSchema

The following example creates a new schema, or updates an existing schema, in the specified policy store. Note that the schema text is shown line wrapped for readability. You should submit the entire schema text as a single line of text.NoteThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.

$result = $client->putSchema([
    'definition' => [
        'cedarJson' => '{"MySampleNamespace": {"actions": {"remoteAccess": {"appliesTo": {"principalTypes": ["Employee"]}}},"entityTypes": {"Employee": {"shape": {"attributes": {"jobLevel": {"type": "Long"},"name": {"type": "String"}},"type": "Record"}}}}}',
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'namespaces' => [
        'My::Sample::Namespace',
    ],
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]

UpdateIdentitySource

$result = $client->updateIdentitySource([/* ... */]);
$promise = $client->updateIdentitySourceAsync([/* ... */]);

Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.

Parameter Syntax

$result = $client->updateIdentitySource([
    'identitySourceId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
    'principalEntityType' => '<string>',
    'updateConfiguration' => [ // REQUIRED
        'cognitoUserPoolConfiguration' => [
            'clientIds' => ['<string>', ...],
            'groupConfiguration' => [
                'groupEntityType' => '<string>', // REQUIRED
            ],
            'userPoolArn' => '<string>', // REQUIRED
        ],
        'openIdConnectConfiguration' => [
            'entityIdPrefix' => '<string>',
            'groupConfiguration' => [
                'groupClaim' => '<string>', // REQUIRED
                'groupEntityType' => '<string>', // REQUIRED
            ],
            'issuer' => '<string>', // REQUIRED
            'tokenSelection' => [ // REQUIRED
                'accessTokenOnly' => [
                    'audiences' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
                'identityTokenOnly' => [
                    'clientIds' => ['<string>', ...],
                    'principalIdClaim' => '<string>',
                ],
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'identitySourceId' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: UpdateIdentitySource

The following example updates the configuration of the specified identity source with a new configuration.

$result = $client->updateIdentitySource([
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'updateConfiguration' => [
        'cognitoUserPoolConfiguration' => [
            'clientIds' => [
                'a1b2c3d4e5f6g7h8i9j0kalbmc',
            ],
            'userPoolArn' => 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5',
        ],
    ],
]);

Result syntax:

[
    'createdDate' => ,
    'identitySourceId' => 'ISEXAMPLEabcdefg111111',
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]

UpdatePolicy

$result = $client->updatePolicy([/* ... */]);
$promise = $client->updatePolicyAsync([/* ... */]);

Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.

Parameter Syntax

$result = $client->updatePolicy([
    'definition' => [ // REQUIRED
        'static' => [
            'description' => '<string>',
            'statement' => '<string>', // REQUIRED
        ],
    ],
    'policyId' => '<string>', // REQUIRED
    'policyStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actions' => [
        [
            'actionId' => '<string>',
            'actionType' => '<string>',
        ],
        // ...
    ],
    'createdDate' => <DateTime>,
    'effect' => 'Permit|Forbid',
    'lastUpdatedDate' => <DateTime>,
    'policyId' => '<string>',
    'policyStoreId' => '<string>',
    'policyType' => 'STATIC|TEMPLATE_LINKED',
    'principal' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
    'resource' => [
        'entityId' => '<string>',
        'entityType' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ServiceQuotaExceededException:

The request failed because it would cause a service quota to be exceeded.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: UpdatePolicy

The following example replaces the definition of the specified static policy with a new one.

$result = $client->updatePolicy([
    'definition' => [
        'static' => [
            'statement' => 'permit(principal, action, resource in Album::"public_folder");',
        ],
    ],
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyId' => '9wYxMpljbbZQb5fcZHyJhY',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyType' => 'STATIC',
    'resource' => [
        'entityId' => 'public_folder',
        'entityType' => 'Album',
    ],
]

UpdatePolicyStore

$result = $client->updatePolicyStore([/* ... */]);
$promise = $client->updatePolicyStoreAsync([/* ... */]);

Modifies the validation setting for a policy store.

Parameter Syntax

$result = $client->updatePolicyStore([
    'description' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
    'validationSettings' => [ // REQUIRED
        'mode' => 'OFF|STRICT', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: UpdatePolicyStore

The following example turns off the validation settings for a policy store.

$result = $client->updatePolicyStore([
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'validationSettings' => [
        'mode' => 'OFF',
    ],
]);

Result syntax:

[
    'arn' => 'arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a',
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
]

UpdatePolicyTemplate

$result = $client->updatePolicyTemplate([/* ... */]);
$promise = $client->updatePolicyTemplateAsync([/* ... */]);

Updates the specified policy template. You can update only the description and the some elements of the policyBody.

Parameter Syntax

$result = $client->updatePolicyTemplate([
    'description' => '<string>',
    'policyStoreId' => '<string>', // REQUIRED
    'policyTemplateId' => '<string>', // REQUIRED
    'statement' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'lastUpdatedDate' => <DateTime>,
    'policyStoreId' => '<string>',
    'policyTemplateId' => '<string>',
]

Result Details

Errors

ValidationException:

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

• UnrecognizedEntityType

  The policy includes an entity type that isn't found in the schema.

• UnrecognizedActionId

  The policy includes an action id that isn't found in the schema.

• InvalidActionApplication

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

• UnexpectedType

  The policy included an operand that isn't a valid type for the specified operation.

• IncompatibleTypes

  The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

• MissingAttribute

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• UnsafeOptionalAttributeAccess

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

• ImpossiblePolicy

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

• WrongNumberArguments

  The policy references an extension type with the wrong number of arguments.

• FunctionArgumentValidationError

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

ConflictException:

The request failed because another request to modify a resource occurred at the same.

AccessDeniedException:

You don't have sufficient access to perform this action.

ResourceNotFoundException:

The request failed because it references a resource that doesn't exist.

ThrottlingException:

The request failed because it exceeded a throttling quota.

InternalServerException:

The request failed because of an internal error. Try your request again later

Examples

Example 1: UpdatePolicyTemplate

The following example updates a policy template with both a new description and a new policy body. The effect, principal, and resource are the same as the original policy template. Only the action in the head, and the when and unless clauses can be different.NoteThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.

$result = $client->updatePolicyTemplate([
    'description' => 'My updated template description',
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
    'statement' => '"ResearchAccess"permit(principal in ?principal,action == Action::"view",resource in ?resource")when {principal has department && principal.department == "research"};',
]);

Result syntax:

[
    'createdDate' => ,
    'lastUpdatedDate' => ,
    'policyStoreId' => 'C7v5xMplfFH3i3e4Jrzb1a',
    'policyTemplateId' => 'PTEXAMPLEabcdefg111111',
]