AWS Directory Service
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ResetUserPassword

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the Administrator user.

  • For AWS Managed Microsoft AD, you cannot reset the password for any user that is in an OU other than the OU that is based off of the NetBIOS name you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.

Request Syntax

{ "DirectoryId": "string", "NewPassword": "string", "UserName": "string" }

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

NewPassword

The new password that will be reset.

Type: String

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

Required: Yes

UserName

The user name of the user whose password will be reset.

Type: String

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

Pattern: ^(?!.*\\|.*"|.*\/|.*\[|.*\]|.*:|.*;|.*\||.*=|.*,|.*\+|.*\*|.*\?|.*<|.*>|.*@).*$

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.

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryUnavailableException

The specified directory is unavailable or could not be found.

HTTP Status Code: 400

EntityDoesNotExistException

The specified entity could not be found.

HTTP Status Code: 400

InvalidPasswordException

The new password provided by the user does not meet the password complexity requirements defined in your directory.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

UserDoesNotExistException

The user provided a username that does not exist in your 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: