CognitoIdentityProvider / Client / admin_user_global_sign_out

admin_user_global_sign_out#

CognitoIdentityProvider.Client.admin_user_global_sign_out(**kwargs)#

Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user’s current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they’re issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.

Calling this action requires developer credentials.

See also: AWS API Documentation

Request Syntax

response = client.admin_user_global_sign_out(
    UserPoolId='string',
    Username='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID.

  • Username (string) –

    [REQUIRED]

    The user name.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The global sign-out response, as an administrator.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.UserNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException