Class: Aws::VerifiedPermissions::Types::BatchIsAuthorizedWithTokenInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-verifiedpermissions/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:identity_token, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

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`.

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 515

class BatchIsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :entities,
  :requests)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#entities ⇒ Types::EntitiesDefinition

(Optional) Specifies the list of resources 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.

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 `BatchIsAuthorizedWithToken` operation takes principal
 attributes from <b> <i>only</i> </b> the `identityToken` or
 `accessToken` passed to the operation.

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

Returns:



515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 515

class BatchIsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :entities,
  :requests)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#identity_token ⇒ String

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`.

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 515

class BatchIsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :entities,
  :requests)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#policy_store_id ⇒ String

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

Returns:

  • (String) 


515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 515

class BatchIsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :entities,
  :requests)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#requests ⇒ Array<Types::BatchIsAuthorizedWithTokenInputItem>

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

Returns:



515
516
517
518
519
520
521
522
523
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 515

class BatchIsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :entities,
  :requests)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end