Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
Synopsis
- adminResetUserPassword :: Text -> Text -> AdminResetUserPassword
- data AdminResetUserPassword
- arupUserPoolId :: Lens' AdminResetUserPassword Text
- arupUsername :: Lens' AdminResetUserPassword Text
- adminResetUserPasswordResponse :: Int -> AdminResetUserPasswordResponse
- data AdminResetUserPasswordResponse
- aruprsResponseStatus :: Lens' AdminResetUserPasswordResponse Int
Creating a Request
adminResetUserPassword Source #
Creates a value of AdminResetUserPassword
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arupUserPoolId
- The user pool ID for the user pool where you want to reset the user's password.arupUsername
- The user name of the user whose password you wish to reset.
data AdminResetUserPassword Source #
Represents the request to reset a user's password as an administrator.
See: adminResetUserPassword
smart constructor.
Instances
Request Lenses
arupUserPoolId :: Lens' AdminResetUserPassword Text Source #
The user pool ID for the user pool where you want to reset the user's password.
arupUsername :: Lens' AdminResetUserPassword Text Source #
The user name of the user whose password you wish to reset.
Destructuring the Response
adminResetUserPasswordResponse Source #
Creates a value of AdminResetUserPasswordResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aruprsResponseStatus
- -- | The response status code.
data AdminResetUserPasswordResponse Source #
Represents the response from the server to reset a user password as an administrator.
See: adminResetUserPasswordResponse
smart constructor.
Instances
Response Lenses
aruprsResponseStatus :: Lens' AdminResetUserPasswordResponse Int Source #
- - | The response status code.