ResetUserPassword
Resets the password for any user in your Amazon Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.
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 Amazon Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Reserved OU. For more information about the OU structure for an Amazon Managed Microsoft AD directory, see What Gets Created
in the Amazon 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 Amazon 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.
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 Amazon 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 Amazon SDKs, see the following: