cognitoidentityprovider_admin_reset_user_password: Resets the specified user's password in a user pool as an...

Description Usage Arguments Value Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Calling this action requires developer credentials.

Usage

1
2
cognitoidentityprovider_admin_reset_user_password(UserPoolId, Username,
  ClientMetadata)

Arguments

UserPoolId

[required] The user pool ID for the user pool where you want to reset the user's password.

Username

[required] The user name of the user whose password you wish to reset.

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 AWS Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito 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 AWS 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.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Value

An empty list.

Request syntax

1
2
3
4
5
6
7
svc$admin_reset_user_password(
  UserPoolId = "string",
  Username = "string",
  ClientMetadata = list(
    "string"
  )
)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.