cognitoidentityprovider_admin_reset_user_password {paws.security.identity} | R Documentation |
Resets the specified user's password in a user pool
Description
Resets the specified user's password in a user pool. This operation doesn't change the user's password, but sends a password-reset code. This operation is the administrative authentication API equivalent to forgot_password
.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_reset_user_password/ for full documentation.
Usage
cognitoidentityprovider_admin_reset_user_password(
UserPoolId,
Username,
ClientMetadata = NULL
)
Arguments
UserPoolId |
[required] The ID of the user pool where you want to reset the user's password. |
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 |
ClientMetadata |
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool
triggers. The
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the
|