Batch Is Authorized With Token

verifiedpermissions_batch_is_authorized_with_token

R Documentation

Makes a series of decisions about multiple authorization requests for one token

Description

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 batch_is_authorized_with_token API request can contain up to 100 resources and up to 99 user groups. The requests of a batch_is_authorized_with_token API request can contain up to 30 requests.

The batch_is_authorized_with_token operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorizedWithToken in their IAM policies.

Usage

verifiedpermissions_batch_is_authorized_with_token(policyStoreId,
  identityToken, accessToken, entities, requests)

Arguments

policyStoreId

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

identityToken

Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

accessToken

Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

entities

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

You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

• The batch_is_authorized_with_token operation takes principal attributes from only the identityToken or accessToken passed to the operation.

• For action entities, you can include only their Identifier and EntityType.

requests

[required] An array of up to 30 requests that you want Verified Permissions to evaluate.

Value

A list with the following syntax:

list(
  principal = list(
    entityType = "string",
    entityId = "string"
  ),
  results = list(
    list(
      request = list(
        action = list(
          actionType = "string",
          actionId = "string"
        ),
        resource = list(
          entityType = "string",
          entityId = "string"
        ),
        context = list(
          contextMap = list(
            list(
              boolean = TRUE|FALSE,
              entityIdentifier = list(
                entityType = "string",
                entityId = "string"
              ),
              long = 123,
              string = "string",
              set = list(
                list()
              ),
              record = list(
                list()
              )
            )
          )
        )
      ),
      decision = "ALLOW"|"DENY",
      determiningPolicies = list(
        list(
          policyId = "string"
        )
      ),
      errors = list(
        list(
          errorDescription = "string"
        )
      )
    )
  )
)

Request syntax

svc$batch_is_authorized_with_token(
  policyStoreId = "string",
  identityToken = "string",
  accessToken = "string",
  entities = list(
    entityList = list(
      list(
        identifier = list(
          entityType = "string",
          entityId = "string"
        ),
        attributes = list(
          list(
            boolean = TRUE|FALSE,
            entityIdentifier = list(
              entityType = "string",
              entityId = "string"
            ),
            long = 123,
            string = "string",
            set = list(
              list()
            ),
            record = list(
              list()
            )
          )
        ),
        parents = list(
          list(
            entityType = "string",
            entityId = "string"
          )
        )
      )
    )
  ),
  requests = list(
    list(
      action = list(
        actionType = "string",
        actionId = "string"
      ),
      resource = list(
        entityType = "string",
        entityId = "string"
      ),
      context = list(
        contextMap = list(
          list(
            boolean = TRUE|FALSE,
            entityIdentifier = list(
              entityType = "string",
              entityId = "string"
            ),
            long = 123,
            string = "string",
            set = list(
              list()
            ),
            record = list(
              list()
            )
          )
        )
      )
    )
  )
)