Class: Aws::VerifiedPermissions::Types::IsAuthorizedWithTokenInput

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 to be authorized. 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) 


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#action ⇒ Types::ActionIdentifier

Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.

Returns:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#context ⇒ Types::ContextDefinition

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

Returns:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#entities ⇒ Types::EntitiesDefinition

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 `IsAuthorizedWithToken` 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:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#identity_token ⇒ String

Specifies an identity token for the principal to be authorized. 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) 


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  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) 


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end

#resource ⇒ Types::EntityIdentifier

Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?

Returns:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 2326

class IsAuthorizedWithTokenInput < Struct.new(
  :policy_store_id,
  :identity_token,
  :access_token,
  :action,
  :resource,
  :context,
  :entities)
  SENSITIVE = [:identity_token, :access_token]
  include Aws::Structure
end