Struct aws_sdk_cognitoidentityprovider::operation::admin_user_global_sign_out::builders::AdminUserGlobalSignOutFluentBuilder

pub struct AdminUserGlobalSignOutFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AdminUserGlobalSignOut.

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior.

• Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.

  Amazon Cognito returns an Access Token has been revoked error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope aws.cognito.signin.user.admin.

• Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with ServerSideTokenCheck enabled for its user pool IdP configuration in CognitoIdentityProvider.

• Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.

Other requests might be valid until your user's token expires.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl AdminUserGlobalSignOutFluentBuilder

pub fn as_input(&self) -> &AdminUserGlobalSignOutInputBuilder

Access the AdminUserGlobalSignOut as a reference.

pub async fn send( self, ) -> Result<AdminUserGlobalSignOutOutput, SdkError<AdminUserGlobalSignOutError, 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<AdminUserGlobalSignOutOutput, AdminUserGlobalSignOutError, Self>

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

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

The user pool ID.

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

The user pool ID.

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

The user pool ID.

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

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Trait Implementations

impl Clone for AdminUserGlobalSignOutFluentBuilder

fn clone(&self) -> AdminUserGlobalSignOutFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminUserGlobalSignOutFluentBuilder

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

Formats the value using the given formatter.