| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.ResetUserPassword
Description
Resets the password for any user in your 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 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 Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
Synopsis
- data ResetUserPassword = ResetUserPassword' {
- directoryId :: Text
- userName :: Text
- newPassword' :: Sensitive Text
- newResetUserPassword :: Text -> Text -> Text -> ResetUserPassword
- resetUserPassword_directoryId :: Lens' ResetUserPassword Text
- resetUserPassword_userName :: Lens' ResetUserPassword Text
- resetUserPassword_newPassword :: Lens' ResetUserPassword Text
- data ResetUserPasswordResponse = ResetUserPasswordResponse' {
- httpStatus :: Int
- newResetUserPasswordResponse :: Int -> ResetUserPasswordResponse
- resetUserPasswordResponse_httpStatus :: Lens' ResetUserPasswordResponse Int
Creating a Request
data ResetUserPassword Source #
See: newResetUserPassword smart constructor.
Constructors
| ResetUserPassword' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResetUserPassword |
Create a value of ResetUserPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryId:ResetUserPassword', resetUserPassword_directoryId - Identifier of the Managed Microsoft AD or Simple AD directory in which
the user resides.
$sel:userName:ResetUserPassword', resetUserPassword_userName - The user name of the user whose password will be reset.
$sel:newPassword':ResetUserPassword', resetUserPassword_newPassword - The new password that will be reset.
Request Lenses
resetUserPassword_directoryId :: Lens' ResetUserPassword Text Source #
Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.
resetUserPassword_userName :: Lens' ResetUserPassword Text Source #
The user name of the user whose password will be reset.
resetUserPassword_newPassword :: Lens' ResetUserPassword Text Source #
The new password that will be reset.
Destructuring the Response
data ResetUserPasswordResponse Source #
See: newResetUserPasswordResponse smart constructor.
Constructors
| ResetUserPasswordResponse' | |
Fields
| |
Instances
newResetUserPasswordResponse Source #
Create a value of ResetUserPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ResetUserPasswordResponse', resetUserPasswordResponse_httpStatus - The response's http status code.
Response Lenses
resetUserPasswordResponse_httpStatus :: Lens' ResetUserPasswordResponse Int Source #
The response's http status code.