cognitoidentityprovider_admin_set_user_password: Sets the specified user's password in a user pool as an...

Description Usage Arguments Details Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

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

Usage

1
2
cognitoidentityprovider_admin_set_user_password(UserPoolId, Username,
  Password, Permanent)

Arguments

UserPoolId

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

Username

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

Password

[required] The password for the user.

Permanent

True if the password is permanent, False if it is temporary.

Details

The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.

Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.

Request syntax

1
2
3
4
5
6
svc$admin_set_user_password(
  UserPoolId = "string",
  Username = "string",
  Password = "string",
  Permanent = TRUE|FALSE
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.