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

Class IsAuthorizedWithTokenRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest

software.amazon.awssdk.services.verifiedpermissions.model.IsAuthorizedWithTokenRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>

@Generated("software.amazon.awssdk:codegen")
public final class IsAuthorizedWithTokenRequest
extends VerifiedPermissionsRequest
implements ToCopyableBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IsAuthorizedWithTokenRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	Specifies an access token for the principal to be authorized.
ActionIdentifier	action()	Specifies the requested action to be authorized.
static IsAuthorizedWithTokenRequest.Builder	builder()
ContextDefinition	context()	Specifies additional context that can be used to make more granular authorization decisions.
EntitiesDefinition	entities()	Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityToken()	Specifies an identity token for the principal to be authorized.
String	policyStoreId()	Specifies the ID of the policy store.
EntityIdentifier	resource()	Specifies the resource for which the authorization decision is made.
List<SdkField<?>>	sdkFields()
static Class<? extends IsAuthorizedWithTokenRequest.Builder>	serializableBuilderClass()
IsAuthorizedWithTokenRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

policyStoreId

public final 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.

Returns:

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

identityToken

public final 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.

Returns:

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.

accessToken

public final 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.

Returns:

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.

action

public final ActionIdentifier action()

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

Returns:

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

resource

public final 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?

Returns:

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

context

public final ContextDefinition context()

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

Returns:

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

entities

public final EntitiesDefinition 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 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:

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 only the identityToken or accessToken passed to the operation.

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

toBuilder

public IsAuthorizedWithTokenRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IsAuthorizedWithTokenRequest.Builder,IsAuthorizedWithTokenRequest>

Specified by:

toBuilder in class VerifiedPermissionsRequest

builder

public static IsAuthorizedWithTokenRequest.Builder builder()

serializableBuilderClass

public static Class<? extends IsAuthorizedWithTokenRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo