Amazon WorkMail
API Reference (API Version 2017-10-01)


Allows the administrator to reset the password for a user.

Request Syntax

{ "OrganizationId": "string", "Password": "string", "UserId": "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.


The identifier of the organization that contains the user for which the password is reset.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes


The new password for the user.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\u0020-\u00FF]+

Required: Yes


The identifier of the user for whom the password is reset.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes

Response Elements

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


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


The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.

HTTP Status Code: 400


The directory that you are trying to perform operations on isn't available.

HTTP Status Code: 400


The identifier supplied for the entity is valid, but it does not exist in your organization.

HTTP Status Code: 400


You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted user.

HTTP Status Code: 400


One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400


The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

HTTP Status Code: 400


An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400


The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

HTTP Status Code: 400


You can't perform a write operation against a read-only directory.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: