Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ResetUserPassword

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Request Syntax


POST /user/userId/password HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

userId

The unique identifier of the user that a temporary password is requested for.

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "temporaryPassword": "string",
   "userId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

temporaryPassword

A randomly generated temporary password for the requested user. This password expires in 7 days.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 20.

Pattern: .*\S.*

userId

The unique identifier of the user that a new password is generated for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with an existing resource.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400