Struct aws_sdk_verifiedpermissions::operation::is_authorized_with_token::builders::IsAuthorizedWithTokenFluentBuilder

pub struct IsAuthorizedWithTokenFluentBuilder { /* private fields */ }

Fluent builder constructing a request to IsAuthorizedWithToken.

Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity 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 evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.

If you specify the identityToken parameter, then this operation derives the principal from that token. You must not also include that principal in the entities parameter or the operation fails and reports a conflict between the two entity sources.

If you provide only an accessToken, then you can include the entity as part of the entities parameter to provide additional attributes.

At this time, Verified Permissions accepts tokens from only Amazon Cognito.

Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

Implementations

impl IsAuthorizedWithTokenFluentBuilder

pub fn as_input(&self) -> &IsAuthorizedWithTokenInputBuilder

Access the IsAuthorizedWithToken as a reference.

pub async fn send( self ) -> Result<IsAuthorizedWithTokenOutput, SdkError<IsAuthorizedWithTokenError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<IsAuthorizedWithTokenOutput, IsAuthorizedWithTokenError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn policy_store_id(self, input: impl Into<String>) -> Self

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

pub fn set_policy_store_id(self, input: Option<String>) -> Self

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

pub fn get_policy_store_id(&self) -> &Option<String>

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

pub fn identity_token(self, input: impl Into<String>) -> Self

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 or an IdentityToken, or both.

pub fn set_identity_token(self, input: Option<String>) -> Self

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 or an IdentityToken, or both.

pub fn get_identity_token(&self) -> &Option<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 or an IdentityToken, or both.

pub fn access_token(self, input: impl Into<String>) -> Self

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, or an IdentityToken, or both.

pub fn set_access_token(self, input: Option<String>) -> Self

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, or an IdentityToken, or both.

pub fn get_access_token(&self) -> &Option<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, or an IdentityToken, or both.

pub fn action(self, input: ActionIdentifier) -> Self

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

pub fn set_action(self, input: Option<ActionIdentifier>) -> Self

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

pub fn get_action(&self) -> &Option<ActionIdentifier>

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

pub fn resource(self, input: EntityIdentifier) -> Self

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

pub fn set_resource(self, input: Option<EntityIdentifier>) -> Self

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

pub fn get_resource(&self) -> &Option<EntityIdentifier>

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

pub fn context(self, input: ContextDefinition) -> Self

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

pub fn set_context(self, input: Option<ContextDefinition>) -> Self

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

pub fn get_context(&self) -> &Option<ContextDefinition>

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

pub fn entities(self, input: EntitiesDefinition) -> Self

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.

pub fn set_entities(self, input: Option<EntitiesDefinition>) -> Self

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.

pub fn get_entities(&self) -> &Option<EntitiesDefinition>

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.

Trait Implementations

impl Clone for IsAuthorizedWithTokenFluentBuilder

fn clone(&self) -> IsAuthorizedWithTokenFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IsAuthorizedWithTokenFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.