/

POST

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.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482TooManyRequestsException

🟠483NotAuthorizedException

🟠484UserNotFoundException

🟠485InternalErrorException

Request Example

Shell

JavaScript

Java

Swift

curl --location '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data '{
    "UserPoolId": "string",
    "Username": "string"
}'

Response Example

200 - Example 1

{}

Modified at 2023-08-15 07:11:06