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.
cognitoidentityprovider_admin_reset_user_password(
UserPoolId,
Username,
ClientMetadata = NULL
)[required] The ID of the user pool where you want to reset the user's password.
[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.
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
admin_reset_user_password
API operation invokes the function that is assigned to the custom
message trigger. When Amazon Cognito invokes this function, it passes a
JSON payload, which the function receives as input. This payload
contains a clientMetadata attribute, which provides the data that you
assigned to the ClientMetadata parameter in your AdminResetUserPassword
request. In your function code in Lambda, you can process the
clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, note that Amazon Cognito
won't do the following:
Store the ClientMetadata value. This data is available only to
Lambda triggers that are assigned to a user pool to support custom
workflows. If your user pool configuration doesn't include triggers,
the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive information
in this parameter.