Admin Disable User

cognitoidentityprovider_admin_disable_user

R Documentation

Deactivates a user and revokes all access tokens for the user

Description

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 get_user and list_users API requests.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_disable_user(UserPoolId, Username)

Arguments

UserPoolId

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

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Value

An empty list.

Request syntax

svc$admin_disable_user(
  UserPoolId = "string",
  Username = "string"
)