amazonka-cognito-idp-1.4.5: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.AdminResetUserPassword

Contents

Description

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.

Synopsis

Creating a Request

adminResetUserPassword #

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 #

Represents the request to reset a user's password as an administrator.

See: adminResetUserPassword smart constructor.

Instances

Eq AdminResetUserPassword # 
Data AdminResetUserPassword # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminResetUserPassword -> c AdminResetUserPassword #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminResetUserPassword #

toConstr :: AdminResetUserPassword -> Constr #

dataTypeOf :: AdminResetUserPassword -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminResetUserPassword) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminResetUserPassword) #

gmapT :: (forall b. Data b => b -> b) -> AdminResetUserPassword -> AdminResetUserPassword #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminResetUserPassword -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminResetUserPassword -> r #

gmapQ :: (forall d. Data d => d -> u) -> AdminResetUserPassword -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminResetUserPassword -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminResetUserPassword -> m AdminResetUserPassword #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminResetUserPassword -> m AdminResetUserPassword #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminResetUserPassword -> m AdminResetUserPassword #

Read AdminResetUserPassword # 
Show AdminResetUserPassword # 
Generic AdminResetUserPassword # 
Hashable AdminResetUserPassword # 
ToJSON AdminResetUserPassword # 
NFData AdminResetUserPassword # 

Methods

rnf :: AdminResetUserPassword -> () #

AWSRequest AdminResetUserPassword # 
ToQuery AdminResetUserPassword # 
ToPath AdminResetUserPassword # 
ToHeaders AdminResetUserPassword # 
type Rep AdminResetUserPassword # 
type Rep AdminResetUserPassword = D1 (MetaData "AdminResetUserPassword" "Network.AWS.CognitoIdentityProvider.AdminResetUserPassword" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" False) (C1 (MetaCons "AdminResetUserPassword'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_arupUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_arupUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)))))
type Rs AdminResetUserPassword # 

Request Lenses

arupUserPoolId :: Lens' AdminResetUserPassword Text #

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

arupUsername :: Lens' AdminResetUserPassword Text #

The user name of the user whose password you wish to reset.

Destructuring the Response

adminResetUserPasswordResponse #

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:

data AdminResetUserPasswordResponse #

Represents the response from the server to reset a user password as an administrator.

See: adminResetUserPasswordResponse smart constructor.

Instances

Eq AdminResetUserPasswordResponse # 
Data AdminResetUserPasswordResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdminResetUserPasswordResponse -> c AdminResetUserPasswordResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdminResetUserPasswordResponse #

toConstr :: AdminResetUserPasswordResponse -> Constr #

dataTypeOf :: AdminResetUserPasswordResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminResetUserPasswordResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdminResetUserPasswordResponse) #

gmapT :: (forall b. Data b => b -> b) -> AdminResetUserPasswordResponse -> AdminResetUserPasswordResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdminResetUserPasswordResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdminResetUserPasswordResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AdminResetUserPasswordResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdminResetUserPasswordResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdminResetUserPasswordResponse -> m AdminResetUserPasswordResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminResetUserPasswordResponse -> m AdminResetUserPasswordResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdminResetUserPasswordResponse -> m AdminResetUserPasswordResponse #

Read AdminResetUserPasswordResponse # 
Show AdminResetUserPasswordResponse # 
Generic AdminResetUserPasswordResponse # 
NFData AdminResetUserPasswordResponse # 
type Rep AdminResetUserPasswordResponse # 
type Rep AdminResetUserPasswordResponse = D1 (MetaData "AdminResetUserPasswordResponse" "Network.AWS.CognitoIdentityProvider.AdminResetUserPassword" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" True) (C1 (MetaCons "AdminResetUserPasswordResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_aruprsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses