AdminSetUserPassword
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
.
You can also set a new temporary password in this request, send it to a user, and
require them to choose a new password on their next sign-in. To do this, set
Permanent
to false
.
If the password is temporary, the user's Status
becomes
FORCE_CHANGE_PASSWORD
. When the user next tries to sign in, the
InitiateAuth
or AdminInitiateAuth
response includes the
NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in
before the temporary password expires, they can no longer sign in and you must repeat
this operation to set a temporary or permanent password for them.
After the user sets a new password, or if you set a permanent password, their status
becomes Confirmed
.
AdminSetUserPassword
can 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 EXTERNAL_PROVIDER
to 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 ChangePassword
and
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.
Note
Amazon Cognito evaluates AWS 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.
Request Syntax
{
"Password": "string
",
"Permanent": boolean
,
"Username": "string
",
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Password
-
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.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
[\S]+
Required: Yes
- Permanent
-
Set to
true
to set a password that the user can immediately sign in with. Set tofalse
to set a temporary password that the user must change on their next sign-in.Type: Boolean
Required: No
- Username
-
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 thesub
of a local user or the username of a user from a third-party IdP.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: Yes
- UserPoolId
-
The ID of the user pool where you want to set the user's password.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidPasswordException
-
This exception is thrown when Amazon Cognito encounters an invalid password.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- PasswordHistoryPolicyViolationException
-
The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user isn't found.
HTTP Status Code: 400
Examples
Example
The following example request sets the user "testuser" to have the password "MyExamplePassword1=", and to be able to sign in with that password without a reset.
Sample Request
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.AdminSetUserPassword
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"Password": "MyExamplePassword1=",
"UserPoolId": "us-west-2_EXAMPLE",
"Username": "testuser",
"Permanent": true
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: