admin_disable_user

CognitoIdentityProvider.Client.admin_disable_user(**kwargs)

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.

You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.

See also: AWS API Documentation

Request Syntax

response = client.admin_disable_user(
    UserPoolId='string',
    Username='string'
)

Parameters

• UserPoolId (string) --

  [REQUIRED]

  The user pool ID for the user pool where you want to disable the user.

• Username (string) --

  [REQUIRED]

  The user name of the user you want to disable.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

  Represents the response received from the server to disable the user 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