Package software.amazon.awssdk.services.verifiedpermissions.model

Interface IsAuthorizedWithTokenRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>, SdkBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>, SdkPojo, SdkRequest.Builder, VerifiedPermissionsRequest.Builder

Enclosing class:

IsAuthorizedWithTokenRequest

public static interface IsAuthorizedWithTokenRequest.Builder
extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>

Method Summary

Modifier and Type	Method	Description
IsAuthorizedWithTokenRequest.Builder	accessToken(String accessToken)	Specifies an access token for the principal to be authorized.
default IsAuthorizedWithTokenRequest.Builder	action(Consumer<ActionIdentifier.Builder> action)	Specifies the requested action to be authorized.
IsAuthorizedWithTokenRequest.Builder	action(ActionIdentifier action)	Specifies the requested action to be authorized.
default IsAuthorizedWithTokenRequest.Builder	context(Consumer<ContextDefinition.Builder> context)	Specifies additional context that can be used to make more granular authorization decisions.
IsAuthorizedWithTokenRequest.Builder	context(ContextDefinition context)	Specifies additional context that can be used to make more granular authorization decisions.
default IsAuthorizedWithTokenRequest.Builder	entities(Consumer<EntitiesDefinition.Builder> entities)	Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
IsAuthorizedWithTokenRequest.Builder	entities(EntitiesDefinition entities)	Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
IsAuthorizedWithTokenRequest.Builder	identityToken(String identityToken)	Specifies an identity token for the principal to be authorized.
IsAuthorizedWithTokenRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
IsAuthorizedWithTokenRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
IsAuthorizedWithTokenRequest.Builder	policyStoreId(String policyStoreId)	Specifies the ID of the policy store.
default IsAuthorizedWithTokenRequest.Builder	resource(Consumer<EntityIdentifier.Builder> resource)	Specifies the resource for which the authorization decision is made.
IsAuthorizedWithTokenRequest.Builder	resource(EntityIdentifier resource)	Specifies the resource for which the authorization decision is made.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest.Builder

build

Method Detail

policyStoreId

IsAuthorizedWithTokenRequest.Builder policyStoreId(String policyStoreId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

identityToken

IsAuthorizedWithTokenRequest.Builder identityToken(String identityToken)

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.

Parameters:

identityToken - 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:

Returns a reference to this object so that method calls can be chained together.

accessToken

IsAuthorizedWithTokenRequest.Builder accessToken(String accessToken)

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.

Parameters:

accessToken - 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:

Returns a reference to this object so that method calls can be chained together.

action

IsAuthorizedWithTokenRequest.Builder action(ActionIdentifier action)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

action

default IsAuthorizedWithTokenRequest.Builder action(Consumer<ActionIdentifier.Builder> action)

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

This is a convenience method that creates an instance of the ActionIdentifier.Builder avoiding the need to create one manually via ActionIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to action(ActionIdentifier).

Parameters:

action - a consumer that will call methods on ActionIdentifier.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

action(ActionIdentifier)

resource

IsAuthorizedWithTokenRequest.Builder resource(EntityIdentifier resource)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

resource

default IsAuthorizedWithTokenRequest.Builder resource(Consumer<EntityIdentifier.Builder> resource)

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

This is a convenience method that creates an instance of the EntityIdentifier.Builder avoiding the need to create one manually via EntityIdentifier.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resource(EntityIdentifier).

Parameters:

resource - a consumer that will call methods on EntityIdentifier.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

resource(EntityIdentifier)

context

IsAuthorizedWithTokenRequest.Builder context(ContextDefinition context)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

context

default IsAuthorizedWithTokenRequest.Builder context(Consumer<ContextDefinition.Builder> context)

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

This is a convenience method that creates an instance of the ContextDefinition.Builder avoiding the need to create one manually via ContextDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to context(ContextDefinition).

Parameters:

context - a consumer that will call methods on ContextDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

context(ContextDefinition)

entities

IsAuthorizedWithTokenRequest.Builder entities(EntitiesDefinition entities)

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

You can include only resource and action entities in this parameter; you can't include principals.

• The IsAuthorizedWithToken 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.

Parameters:

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

You can include only resource and action entities in this parameter; you can't include principals.

• The IsAuthorizedWithToken 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

entities

default IsAuthorizedWithTokenRequest.Builder entities(Consumer<EntitiesDefinition.Builder> entities)

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

You can include only resource and action entities in this parameter; you can't include principals.

• The IsAuthorizedWithToken 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.

This is a convenience method that creates an instance of the EntitiesDefinition.Builder avoiding the need to create one manually via EntitiesDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entities(EntitiesDefinition).

Parameters:

entities - a consumer that will call methods on EntitiesDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

entities(EntitiesDefinition)

overrideConfiguration

IsAuthorizedWithTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

IsAuthorizedWithTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder