admin_set_user_password

CognitoIdentityProvider.Client.admin_set_user_password(**kwargs)

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

The password can be temporary or permanent. If it is temporary, the user status enters 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 doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.

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

See also: AWS API Documentation

Request Syntax

response = client.admin_set_user_password(
    UserPoolId='string',
    Username='string',
    Password='string',
    Permanent=True|False
)

Parameters

• UserPoolId (string) --

  [REQUIRED]

  The user pool ID for the user pool where you want to set the user's password.

• Username (string) --

  [REQUIRED]

  The user name of the user whose password you want to set.

• Password (string) --

  [REQUIRED]

  The password for the user.

• Permanent (boolean) -- True if the password is permanent, False if it is temporary.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.UserNotFoundException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException
• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.InvalidPasswordException