VerifiedPermissions / Client / is_authorized

is_authorized#

VerifiedPermissions.Client.is_authorized(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.is_authorized(
    policyStoreId='string',
    principal={
        'entityType': 'string',
        'entityId': 'string'
    },
    action={
        'actionType': 'string',
        'actionId': 'string'
    },
    resource={
        'entityType': 'string',
        'entityId': 'string'
    },
    context={
        'contextMap': {
            'string': {
                'boolean': True|False,
                'entityIdentifier': {
                    'entityType': 'string',
                    'entityId': 'string'
                },
                'long': 123,
                'string': 'string',
                'set': [
                    {'... recursive ...'},
                ],
                'record': {
                    'string': {'... recursive ...'}
                },
                'ipaddr': 'string',
                'decimal': 'string'
            }
        }
    },
    entities={
        'entityList': [
            {
                'identifier': {
                    'entityType': 'string',
                    'entityId': 'string'
                },
                'attributes': {
                    'string': {
                        'boolean': True|False,
                        'entityIdentifier': {
                            'entityType': 'string',
                            'entityId': 'string'
                        },
                        'long': 123,
                        'string': 'string',
                        'set': [
                            {'... recursive ...'},
                        ],
                        'record': {
                            'string': {'... recursive ...'}
                        },
                        'ipaddr': 'string',
                        'decimal': 'string'
                    }
                },
                'parents': [
                    {
                        'entityType': 'string',
                        'entityId': 'string'
                    },
                ]
            },
        ]
    }
)
Parameters:

  • policyStoreId (string) –

    [REQUIRED]

    Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

  • principal (dict) –

    Specifies the principal for which the authorization decision is to be made.

    • entityType (string) – [REQUIRED]

      The type of an entity.

      Example: "entityType":"typeName"

    • entityId (string) – [REQUIRED]

      The identifier of an entity.

      "entityId":"identifier"

  • action (dict) –

    Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?

    • actionType (string) – [REQUIRED]

      The type of an action.

    • actionId (string) – [REQUIRED]

      The ID of an action.

  • resource (dict) –

    Specifies the resource for which the authorization decision is to be made.

    • entityType (string) – [REQUIRED]

      The type of an entity.

      Example: "entityType":"typeName"

    • entityId (string) – [REQUIRED]

      The identifier of an entity.

      "entityId":"identifier"

  • context (dict) –

    Specifies additional context that can be used to make more granular authorization decisions.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: contextMap.

    • contextMap (dict) –

      An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

      Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

      • (string) –

        • (dict) –

          The value of an attribute.

          Contains information about the runtime context for a request for which an authorization decision is made.

          This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

          • boolean (boolean) –

            An attribute value of Boolean type.

            Example: {"boolean": true}

          • entityIdentifier (dict) –

            An attribute value of type EntityIdentifier.

            Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

            • entityType (string) – [REQUIRED]

              The type of an entity.

              Example: "entityType":"typeName"

            • entityId (string) – [REQUIRED]

              The identifier of an entity.

              "entityId":"identifier"

          • long (integer) –

            An attribute value of Long type.

            Example: {"long": 0}

          • string (string) –

            An attribute value of String type.

            Example: {"string": "abc"}

          • set (list) –

            An attribute value of Set type.

            Example: {"set": [ {} ] }

            • (dict) –

              The value of an attribute.

              Contains information about the runtime context for a request for which an authorization decision is made.

              This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

          • record (dict) –

            An attribute value of Record type.

            Example: {"record": { "keyName": {} } }

            • (string) –

              • (dict) –

                The value of an attribute.

                Contains information about the runtime context for a request for which an authorization decision is made.

                This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

                Note

                This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

          • ipaddr (string) –

            An attribute value of ipaddr type.

            Example: {"ip": "192.168.1.100"}

          • decimal (string) –

            An attribute value of decimal type.

            Example: {"decimal": "1.1"}

  • entities (dict) –

    Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.

    Note

    You can include only principal and resource entities in this parameter; you can’t include actions. You must specify actions in the schema.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: entityList.

    • entityList (list) –

      An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.

      • (dict) –

        Contains information about an entity that can be referenced in a Cedar policy.

        This data type is used as one of the fields in the EntitiesDefinition structure.

        { "identifier": { "entityType": "Photo", "entityId": "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ { "entityType": "Album", "entityId": "alice_folder" } ] }

        • identifier (dict) – [REQUIRED]

          The identifier of the entity.

          • entityType (string) – [REQUIRED]

            The type of an entity.

            Example: "entityType":"typeName"

          • entityId (string) – [REQUIRED]

            The identifier of an entity.

            "entityId":"identifier"

        • attributes (dict) –

          A list of attributes for the entity.

          • (string) –

            • (dict) –

              The value of an attribute.

              Contains information about the runtime context for a request for which an authorization decision is made.

              This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

              Note

              This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

              • boolean (boolean) –

                An attribute value of Boolean type.

                Example: {"boolean": true}

              • entityIdentifier (dict) –

                An attribute value of type EntityIdentifier.

                Example: "entityIdentifier": { "entityId": "<id>", "entityType": "<entity type>"}

                • entityType (string) – [REQUIRED]

                  The type of an entity.

                  Example: "entityType":"typeName"

                • entityId (string) – [REQUIRED]

                  The identifier of an entity.

                  "entityId":"identifier"

              • long (integer) –

                An attribute value of Long type.

                Example: {"long": 0}

              • string (string) –

                An attribute value of String type.

                Example: {"string": "abc"}

              • set (list) –

                An attribute value of Set type.

                Example: {"set": [ {} ] }

                • (dict) –

                  The value of an attribute.

                  Contains information about the runtime context for a request for which an authorization decision is made.

                  This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

                  Note

                  This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

              • record (dict) –

                An attribute value of Record type.

                Example: {"record": { "keyName": {} } }

                • (string) –

                  • (dict) –

                    The value of an attribute.

                    Contains information about the runtime context for a request for which an authorization decision is made.

                    This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

                    Note

                    This is a Tagged Union structure. Only one of the following top level keys can be set: boolean, entityIdentifier, long, string, set, record, ipaddr, decimal.

              • ipaddr (string) –

                An attribute value of ipaddr type.

                Example: {"ip": "192.168.1.100"}

              • decimal (string) –

                An attribute value of decimal type.

                Example: {"decimal": "1.1"}

        • parents (list) –

          The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.

          A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.

          • (dict) –

            Contains the identifier of an entity, including its ID and type.

            This data type is used as a request parameter for IsAuthorized operation, and as a response parameter for the CreatePolicy, GetPolicy, and UpdatePolicy operations.

            Example: {"entityId":"string","entityType":"string"}

            • entityType (string) – [REQUIRED]

              The type of an entity.

              Example: "entityType":"typeName"

            • entityId (string) – [REQUIRED]

              The identifier of an entity.

              "entityId":"identifier"

Return type:

dict

Returns:

Response Syntax

{
    'decision': 'ALLOW'|'DENY',
    'determiningPolicies': [
        {
            'policyId': 'string'
        },
    ],
    'errors': [
        {
            'errorDescription': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • decision (string) –

      An authorization decision that indicates if the authorization request should be allowed or denied.

    • determiningPolicies (list) –

      The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.

      • (dict) –

        Contains information about one of the policies that determined an authorization decision.

        This data type is used as an element in a response parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

        Example: "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}]

        • policyId (string) –

          The Id of a policy that determined to an authorization decision.

          Example: "policyId":"SPEXAMPLEabcdefg111111"

    • errors (list) –

      Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.

Exceptions

  • VerifiedPermissions.Client.exceptions.ValidationException

  • VerifiedPermissions.Client.exceptions.AccessDeniedException

  • VerifiedPermissions.Client.exceptions.ResourceNotFoundException

  • VerifiedPermissions.Client.exceptions.ThrottlingException

  • VerifiedPermissions.Client.exceptions.InternalServerException