| Copyright | (c) 2013-2023 Brendan Hay | 
|---|---|
| License | Mozilla Public License, v. 2.0. | 
| Maintainer | Brendan Hay | 
| Stability | auto-generated | 
| Portability | non-portable (GHC extensions) | 
| Safe Haskell | Safe-Inferred | 
| Language | Haskell2010 | 
Amazonka.FinSpaceData.ResetUserPassword
Description
Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
Synopsis
- data ResetUserPassword = ResetUserPassword' {
- clientToken :: Maybe Text
 - userId :: Text
 
 - newResetUserPassword :: Text -> ResetUserPassword
 - resetUserPassword_clientToken :: Lens' ResetUserPassword (Maybe Text)
 - resetUserPassword_userId :: Lens' ResetUserPassword Text
 - data ResetUserPasswordResponse = ResetUserPasswordResponse' {
- temporaryPassword :: Maybe (Sensitive Text)
 - userId :: Maybe Text
 - httpStatus :: Int
 
 - newResetUserPasswordResponse :: Int -> ResetUserPasswordResponse
 - resetUserPasswordResponse_temporaryPassword :: Lens' ResetUserPasswordResponse (Maybe Text)
 - resetUserPasswordResponse_userId :: Lens' ResetUserPasswordResponse (Maybe Text)
 - resetUserPasswordResponse_httpStatus :: Lens' ResetUserPasswordResponse Int
 
Creating a Request
data ResetUserPassword Source #
See: newResetUserPassword smart constructor.
Constructors
| ResetUserPassword' | |
Fields 
  | |
Instances
Arguments
| :: 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:clientToken:ResetUserPassword', resetUserPassword_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
ResetUserPassword, resetUserPassword_userId - The unique identifier of the user that a temporary password is requested
 for.
Request Lenses
resetUserPassword_clientToken :: Lens' ResetUserPassword (Maybe Text) Source #
A token that ensures idempotency. This token expires in 10 minutes.
resetUserPassword_userId :: Lens' ResetUserPassword Text Source #
The unique identifier of the user that a temporary password is requested for.
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:temporaryPassword:ResetUserPasswordResponse', resetUserPasswordResponse_temporaryPassword - A randomly generated temporary password for the requested user account.
 This password expires in 7 days.
ResetUserPassword, resetUserPasswordResponse_userId - The unique identifier of the user that a new password is generated for.
$sel:httpStatus:ResetUserPasswordResponse', resetUserPasswordResponse_httpStatus - The response's http status code.
Response Lenses
resetUserPasswordResponse_temporaryPassword :: Lens' ResetUserPasswordResponse (Maybe Text) Source #
A randomly generated temporary password for the requested user account. This password expires in 7 days.
resetUserPasswordResponse_userId :: Lens' ResetUserPasswordResponse (Maybe Text) Source #
The unique identifier of the user that a new password is generated for.
resetUserPasswordResponse_httpStatus :: Lens' ResetUserPasswordResponse Int Source #
The response's http status code.