AdminSetUserPassword
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 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
{
"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 password for the user.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 256.
Pattern:
[\S]+
Required: Yes
- Permanent
-
True
if the password is permanent,False
if it is temporary.Type: Boolean
Required: No
- Username
-
The user name of the user whose password you wish to set.
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 user pool ID for 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 the Amazon Cognito service encounters an invalid password.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot 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 is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: