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

Description Usage Arguments Details 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.

Usage

1

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.

Details

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.

Requires developer credentials.

Request syntax

1
2
3
4
svc$admin_reset_user_password(
  UserPoolId = "string",
  Username = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.