Skip to contents

Deactivates a user profile and revokes all access tokens for the user

Source: R/cognitoidentityprovider_operations.R
cognitoidentityprovider_admin_disable_user.Rd

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

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_disable_user/ for full documentation.

Usage

cognitoidentityprovider_admin_disable_user(UserPoolId, Username)

Arguments

UserPoolId

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

Username

[required] The name 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.