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.ForgotPassword

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Synopsis

data ForgotPassword = ForgotPassword' {
- analyticsMetadata :: Maybe AnalyticsMetadataType
- clientMetadata :: Maybe (HashMap Text Text)
- secretHash :: Maybe (Sensitive Text)
- userContextData :: Maybe UserContextDataType
- clientId :: Sensitive Text
- username :: Sensitive Text
}
newForgotPassword :: Text -> Text -> ForgotPassword
forgotPassword_analyticsMetadata :: Lens' ForgotPassword (Maybe AnalyticsMetadataType)
forgotPassword_clientMetadata :: Lens' ForgotPassword (Maybe (HashMap Text Text))
forgotPassword_secretHash :: Lens' ForgotPassword (Maybe Text)
forgotPassword_userContextData :: Lens' ForgotPassword (Maybe UserContextDataType)
forgotPassword_clientId :: Lens' ForgotPassword Text
forgotPassword_username :: Lens' ForgotPassword Text
data ForgotPasswordResponse = ForgotPasswordResponse' {
- codeDeliveryDetails :: Maybe CodeDeliveryDetailsType
- httpStatus :: Int
}
newForgotPasswordResponse :: Int -> ForgotPasswordResponse
forgotPasswordResponse_codeDeliveryDetails :: Lens' ForgotPasswordResponse (Maybe CodeDeliveryDetailsType)
forgotPasswordResponse_httpStatus :: Lens' ForgotPasswordResponse Int

Creating a Request

data ForgotPassword Source #

Represents the request to reset a user's password.

See: newForgotPassword smart constructor.

Constructors

ForgotPassword'

Fields

analyticsMetadata :: Maybe AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
clientMetadata :: Maybe (HashMap Text Text)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: /pre sign-up, custom message, and user migration/. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
secretHash :: Maybe (Sensitive Text)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
userContextData :: Maybe UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
clientId :: Sensitive Text
The ID of the client associated with the user pool.
username :: Sensitive Text
The user name of the user for whom you want to enter a code to reset a forgotten password.

Instances

Instances details

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

newForgotPassword Source #

Arguments

:: Text	`ForgotPassword`
-> Text	`ForgotPassword`
-> ForgotPassword

Create a value of ForgotPassword 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:analyticsMetadata:ForgotPassword', forgotPassword_analyticsMetadata - The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

$sel:clientMetadata:ForgotPassword', forgotPassword_clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: /pre sign-up, custom message, and user migration/. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

$sel:secretHash:ForgotPassword', forgotPassword_secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

$sel:userContextData:ForgotPassword', forgotPassword_userContextData - Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

ForgotPassword, forgotPassword_clientId - The ID of the client associated with the user pool.

ForgotPassword, forgotPassword_username - The user name of the user for whom you want to enter a code to reset a forgotten password.

Request Lenses

forgotPassword_analyticsMetadata :: Lens' ForgotPassword (Maybe AnalyticsMetadataType) Source #

The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

forgotPassword_clientMetadata :: Lens' ForgotPassword (Maybe (HashMap Text Text)) Source #

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: /pre sign-up, custom message, and user migration/. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

forgotPassword_secretHash :: Lens' ForgotPassword (Maybe Text) Source #

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

forgotPassword_userContextData :: Lens' ForgotPassword (Maybe UserContextDataType) Source #

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

forgotPassword_clientId :: Lens' ForgotPassword Text Source #

The ID of the client associated with the user pool.

forgotPassword_username :: Lens' ForgotPassword Text Source #

The user name of the user for whom you want to enter a code to reset a forgotten password.

Destructuring the Response

data ForgotPasswordResponse Source #

The response from Amazon Cognito to a request to reset a password.

See: newForgotPasswordResponse smart constructor.

Constructors

ForgotPasswordResponse'
Fields codeDeliveryDetails :: Maybe CodeDeliveryDetailsType The code delivery details returned by the server in response to the request to reset a password. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newForgotPasswordResponse Source #

Arguments

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

Create a value of ForgotPasswordResponse 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:codeDeliveryDetails:ForgotPasswordResponse', forgotPasswordResponse_codeDeliveryDetails - The code delivery details returned by the server in response to the request to reset a password.

$sel:httpStatus:ForgotPasswordResponse', forgotPasswordResponse_httpStatus - The response's http status code.

Response Lenses

forgotPasswordResponse_codeDeliveryDetails :: Lens' ForgotPasswordResponse (Maybe CodeDeliveryDetailsType) Source #

The code delivery details returned by the server in response to the request to reset a password.

forgotPasswordResponse_httpStatus :: Lens' ForgotPasswordResponse Int Source #

The response's http status code.