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

ResetPassword

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.

OrganizationId

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

Password

The new password for the user.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\u0020-\u00FF]+

Required: Yes

UserId

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.

Errors

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

DirectoryServiceAuthenticationFailedException

The directory service doesn't recognize the credentials supplied by WorkMail.

HTTP Status Code: 400

DirectoryUnavailableException

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

HTTP Status Code: 400

EntityNotFoundException

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

EntityStateException

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

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

InvalidPasswordException

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

HTTP Status Code: 400

OrganizationNotFoundException

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

HTTP Status Code: 400

OrganizationStateException

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

HTTP Status Code: 400

UnsupportedOperationException

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: