Learn R Programming

paws.security.identity (version 0.8.0)

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

Description

Sets the specified user's password in a user pool. This operation administratively sets a temporary or permanent password for a user. With this operation, you can bypass self-service password changes and permit immediate sign-in with the password that you set. To do this, set Permanent to true.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_set_user_password/ for full documentation.

Usage

cognitoidentityprovider_admin_set_user_password(
  UserPoolId,
  Username,
  Password,
  Permanent = NULL
)

Arguments

UserPoolId

[required] The ID of the user pool where you want to set 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 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.

Password

[required] The new temporary or permanent password that you want to set for the user. You can't remove the password for a user who already has a password so that they can only sign in with passwordless methods. In this scenario, you must create a new user without a password.

Permanent

Set to true to set a password that the user can immediately sign in with. Set to false to set a temporary password that the user must change on their next sign-in.