is_authorized ¶

def is_authorized(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    *,
    config_overrides: Optional[VerifiedPermissionsClientConfig] = None,
    principal: Optional[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ] = None,
    action: Optional[
        "capo_verifiedpermissions.types.action_identifier.ActionIdentifier"
    ] = None,
    resource: Optional[
        "capo_verifiedpermissions.types.entity_identifier.EntityIdentifier"
    ] = None,
    context: Optional[
        "capo_verifiedpermissions.types.context_definition.ContextDefinition"
    ] = None,
    entities: Optional[
        "capo_verifiedpermissions.types.entities_definition.EntitiesDefinition"
    ] = None,
) -> "capo_verifiedpermissions.types.is_authorized_output.IsAuthorizedOutput":
    """<p>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 <code>Allow</code> or <code>Deny</code>, along with a list of the policies that resulted in the decision.</p>

            Args:
                policy_store_id: <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
                principal: <p>Specifies the principal for which the authorization decision is to be made.</p>
                action: <p>Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?</p>
                resource: <p>Specifies the resource for which the authorization decision is to be made.</p>
                context: <p>Specifies additional context that can be used to make more granular authorization decisions.</p>
                entities: <p>(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <note> <p>You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.</p> </note>

            Raises:
                capo_verifiedpermissions.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
                capo_verifiedpermissions.errors.internal_server_exception.InternalServerException: <p>The request failed because of an internal error. Try your request again later</p>
                capo_verifiedpermissions.errors.throttling_exception.ThrottlingException: <p>The request failed because it exceeded a throttling quota.</p>
                capo_verifiedpermissions.errors.validation_exception.ValidationException: <p>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.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>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 <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>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 <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>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.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>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.</p> </li> </ul>
                capo_verifiedpermissions.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request failed because it references a resource that doesn't exist.</p>
                capo_verifiedpermissions.errors.UnknownServiceError: The service returned an error code this client does not model.

            Examples:
                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.

                >>> client.is_authorized(principal={'entityType': 'User', 'entityId': 'alice'}, action={'actionType': 'Action', 'actionId': 'updatePhoto'}, resource={'entityType': 'Photo', 'entityId': 'VacationPhoto94.jpg'}, policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')
                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.

                >>> client.is_authorized(principal={'entityType': 'User', 'entityId': 'bob'}, action={'actionType': 'Action', 'actionId': 'view'}, resource={'entityType': 'Photo', 'entityId': 'VacationPhoto94.jpg'}, policy_store_id='C7v5xMplfFH3i3e4Jrzb1a')
    """

    def _handler(
        req: "OperationRequest[capo_verifiedpermissions.types.is_authorized_input.IsAuthorizedInput]",
    ) -> OperationResponse[
        "capo_verifiedpermissions.types.is_authorized_output.IsAuthorizedOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.is_authorized

        output, http_response = (
            capo_verifiedpermissions._operations.verified_permissions.is_authorized.is_authorized(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_verifiedpermissions.types.is_authorized_input.IsAuthorizedInput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.is_authorized_input

        return capo_verifiedpermissions.types.is_authorized_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_verifiedpermissions.types.is_authorized_output.IsAuthorizedOutput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.is_authorized_output

        return capo_verifiedpermissions.types.is_authorized_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "IsAuthorized", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_verifiedpermissions.types.is_authorized_input.IsAuthorizedInput = {
        "policy_store_id": policy_store_id
    }
    if principal is not None:
        input_["principal"] = principal
    if action is not None:
        input_["action"] = action
    if resource is not None:
        input_["resource"] = resource
    if context is not None:
        input_["context"] = context
    if entities is not None:
        input_["entities"] = entities

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output