global_sign_out

global_sign_out(**kwargs)

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

See also: AWS API Documentation

Request Syntax

response = client.global_sign_out(
    AccessToken='string'
)

Parameters

AccessToken (string) --

[REQUIRED]

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  The response to the request to sign out all devices.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
• CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException
• CognitoIdentityProvider.Client.exceptions.ForbiddenException