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.CognitoIdentityProvider.AdminSetUserPassword

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the specified user's password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.

Once the user has set a new password, or the password is permanent, the user status is set to Confirmed.

Creating a Request

data AdminSetUserPassword Source #

See: newAdminSetUserPassword smart constructor.

Constructors

AdminSetUserPassword'
Fields permanent :: Maybe Bool `True` if the password is permanent, `False` if it is temporary. userPoolId :: Text The user pool ID for the user pool where you want to set the user's password. username :: Sensitive Text The user name of the user whose password you want to set. password :: Sensitive Text The password for the user.

Instances

Instances details

ToJSON AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods toJSON :: AdminSetUserPassword -> Value # toEncoding :: AdminSetUserPassword -> Encoding # toJSONList :: [AdminSetUserPassword] -> Value # toEncodingList :: [AdminSetUserPassword] -> Encoding #
ToHeaders AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods toHeaders :: AdminSetUserPassword -> [Header] #
ToPath AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods toPath :: AdminSetUserPassword -> ByteString #
ToQuery AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods toQuery :: AdminSetUserPassword -> QueryString #
AWSRequest AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Associated Types type AWSResponse AdminSetUserPassword # Methods request :: (Service -> Service) -> AdminSetUserPassword -> Request AdminSetUserPassword # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AdminSetUserPassword -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminSetUserPassword))) #
Generic AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Associated Types type Rep AdminSetUserPassword :: Type -> Type # Methods from :: AdminSetUserPassword -> Rep AdminSetUserPassword x # to :: Rep AdminSetUserPassword x -> AdminSetUserPassword #
Show AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods showsPrec :: Int -> AdminSetUserPassword -> ShowS # show :: AdminSetUserPassword -> String # showList :: [AdminSetUserPassword] -> ShowS #
NFData AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods rnf :: AdminSetUserPassword -> () #
Eq AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods (==) :: AdminSetUserPassword -> AdminSetUserPassword -> Bool # (/=) :: AdminSetUserPassword -> AdminSetUserPassword -> Bool #
Hashable AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods hashWithSalt :: Int -> AdminSetUserPassword -> Int # hash :: AdminSetUserPassword -> Int #
type AWSResponse AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword type AWSResponse AdminSetUserPassword = AdminSetUserPasswordResponse
type Rep AdminSetUserPassword Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword type Rep AdminSetUserPassword = D1 ('MetaData "AdminSetUserPassword" "Amazonka.CognitoIdentityProvider.AdminSetUserPassword" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminSetUserPassword'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "permanent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))

newAdminSetUserPassword Source #

Arguments

:: Text	`AdminSetUserPassword`
-> Text	`AdminSetUserPassword`
-> Text	`$sel:password:AdminSetUserPassword'`
-> AdminSetUserPassword

Create a value of AdminSetUserPassword 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:permanent:AdminSetUserPassword', adminSetUserPassword_permanent - True if the password is permanent, False if it is temporary.

AdminSetUserPassword, adminSetUserPassword_userPoolId - The user pool ID for the user pool where you want to set the user's password.

AdminSetUserPassword, adminSetUserPassword_username - The user name of the user whose password you want to set.

$sel:password:AdminSetUserPassword', adminSetUserPassword_password - The password for the user.

Request Lenses

adminSetUserPassword_permanent :: Lens' AdminSetUserPassword (Maybe Bool) Source #

True if the password is permanent, False if it is temporary.

adminSetUserPassword_userPoolId :: Lens' AdminSetUserPassword Text Source #

The user pool ID for the user pool where you want to set the user's password.

adminSetUserPassword_username :: Lens' AdminSetUserPassword Text Source #

The user name of the user whose password you want to set.

adminSetUserPassword_password :: Lens' AdminSetUserPassword Text Source #

The password for the user.

Destructuring the Response

data AdminSetUserPasswordResponse Source #

See: newAdminSetUserPasswordResponse smart constructor.

Constructors

AdminSetUserPasswordResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Associated Types type Rep AdminSetUserPasswordResponse :: Type -> Type # Methods from :: AdminSetUserPasswordResponse -> Rep AdminSetUserPasswordResponse x # to :: Rep AdminSetUserPasswordResponse x -> AdminSetUserPasswordResponse #
Read AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods readsPrec :: Int -> ReadS AdminSetUserPasswordResponse # readList :: ReadS [AdminSetUserPasswordResponse] # readPrec :: ReadPrec AdminSetUserPasswordResponse # readListPrec :: ReadPrec [AdminSetUserPasswordResponse] #
Show AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods showsPrec :: Int -> AdminSetUserPasswordResponse -> ShowS # show :: AdminSetUserPasswordResponse -> String # showList :: [AdminSetUserPasswordResponse] -> ShowS #
NFData AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods rnf :: AdminSetUserPasswordResponse -> () #
Eq AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword Methods (==) :: AdminSetUserPasswordResponse -> AdminSetUserPasswordResponse -> Bool # (/=) :: AdminSetUserPasswordResponse -> AdminSetUserPasswordResponse -> Bool #
type Rep AdminSetUserPasswordResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminSetUserPassword type Rep AdminSetUserPasswordResponse = D1 ('MetaData "AdminSetUserPasswordResponse" "Amazonka.CognitoIdentityProvider.AdminSetUserPassword" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminSetUserPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAdminSetUserPasswordResponse Source #

Arguments

:: Int	`$sel:httpStatus:AdminSetUserPasswordResponse'`
-> AdminSetUserPasswordResponse

Create a value of AdminSetUserPasswordResponse 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:AdminSetUserPasswordResponse', adminSetUserPasswordResponse_httpStatus - The response's http status code.

Response Lenses

adminSetUserPasswordResponse_httpStatus :: Lens' AdminSetUserPasswordResponse Int Source #

The response's http status code.