CognitoIdentityProvider / Client / admin_set_user_password
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_PASSWORDstate. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the
NEW_PASSWORD_REQUIREDchallenge. 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
AdminSetUserPasswordcan set a password for the user profile that Amazon Cognito creates for third-party federated users. When you set a password, the federated user’s status changes from
CONFIRMED. A user in this state can sign in as a federated user, and initiate authentication flows in the API like a linked native user. They can also modify their password and attributes in token-authenticated API requests like
UpdateUserAttributes. As a best security practice and to keep users in sync with your external IdP, don’t set passwords on federated user profiles. To set up a federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
See also: AWS API Documentation
response = client.admin_set_user_password( UserPoolId='string', Username='string', Password='string', Permanent=True|False )
UserPoolId (string) –
The user pool ID for the user pool where you want to set the user’s password.
Username (string) –
The user name of the user whose password you want to set.
Password (string) –
The password for the user.
Permanent (boolean) –
Trueif the password is permanent,
Falseif it is temporary.
- Return type: