Post x amz targetawscognitoidentityproviderservice.admindisableuser

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14101465558.4 KB

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.

post/#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableUser

Headers

X-Amz-Target'AWSCognitoIdentityProviderService.AdminDisableUser' required

Request body

UserPoolIdstring required

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

Usernamestring password required

The user name of the user you want to disable.

Response

Success

AdminDisableUserResponse required

Represents the response received from the server to disable the user as an administrator.