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 |
Initiates sign-in for a user in the Amazon Cognito user directory. You
can't sign in a user with a federated IdP with InitiateAuth
. For more
information, see
Adding user pool sign-in through a third party.
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 InitiateAuth = InitiateAuth' {}
- newInitiateAuth :: AuthFlowType -> Text -> InitiateAuth
- initiateAuth_analyticsMetadata :: Lens' InitiateAuth (Maybe AnalyticsMetadataType)
- initiateAuth_authParameters :: Lens' InitiateAuth (Maybe (HashMap Text Text))
- initiateAuth_clientMetadata :: Lens' InitiateAuth (Maybe (HashMap Text Text))
- initiateAuth_userContextData :: Lens' InitiateAuth (Maybe UserContextDataType)
- initiateAuth_authFlow :: Lens' InitiateAuth AuthFlowType
- initiateAuth_clientId :: Lens' InitiateAuth Text
- data InitiateAuthResponse = InitiateAuthResponse' {}
- newInitiateAuthResponse :: Int -> InitiateAuthResponse
- initiateAuthResponse_authenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType)
- initiateAuthResponse_challengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType)
- initiateAuthResponse_challengeParameters :: Lens' InitiateAuthResponse (Maybe (HashMap Text Text))
- initiateAuthResponse_session :: Lens' InitiateAuthResponse (Maybe Text)
- initiateAuthResponse_httpStatus :: Lens' InitiateAuthResponse Int
Creating a Request
data InitiateAuth Source #
Initiates the authentication request.
See: newInitiateAuth
smart constructor.
InitiateAuth' | |
|
Instances
Create a value of InitiateAuth
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:InitiateAuth'
, initiateAuth_analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics
for InitiateAuth
calls.
$sel:authParameters:InitiateAuth'
, initiateAuth_authParameters
- The authentication parameters. These are inputs corresponding to the
AuthFlow
that you're invoking. The required values depend on the
value of AuthFlow
:
- For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. - For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. - For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
$sel:clientMetadata:InitiateAuth'
, initiateAuth_clientMetadata
- A map of custom key-value pairs that you can provide as input for
certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes
a JSON payload, which the function receives as input. This payload
contains a validationData
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your InitiateAuth request.
In your function code in Lambda, you can process the validationData
value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Verify auth challenge
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:userContextData:InitiateAuth'
, initiateAuth_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.
$sel:authFlow:InitiateAuth'
, initiateAuth_authFlow
- The authentication flow for this call to run. The API action will depend
on this value. For example:
REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens.USER_SRP_AUTH
takes inUSERNAME
andSRP_A
and returns the SRP variables to be used for next challenge execution.USER_PASSWORD_AUTH
takes inUSERNAME
andPASSWORD
and returns the next challenge or tokens.
Valid values include:
USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol.REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.CUSTOM_AUTH
: Custom authentication flow.USER_PASSWORD_AUTH
: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH
isn't a valid value.
InitiateAuth
, initiateAuth_clientId
- The app client ID.
Request Lenses
initiateAuth_analyticsMetadata :: Lens' InitiateAuth (Maybe AnalyticsMetadataType) Source #
The Amazon Pinpoint analytics metadata that contributes to your metrics
for InitiateAuth
calls.
initiateAuth_authParameters :: Lens' InitiateAuth (Maybe (HashMap Text Text)) Source #
The authentication parameters. These are inputs corresponding to the
AuthFlow
that you're invoking. The required values depend on the
value of AuthFlow
:
- For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. - For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
. - For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
initiateAuth_clientMetadata :: Lens' InitiateAuth (Maybe (HashMap Text Text)) Source #
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes
a JSON payload, which the function receives as input. This payload
contains a validationData
attribute, which provides the data that you
assigned to the ClientMetadata parameter in your InitiateAuth request.
In your function code in Lambda, you can process the validationData
value to enhance your workflow for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Verify auth challenge
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.
initiateAuth_userContextData :: Lens' InitiateAuth (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.
initiateAuth_authFlow :: Lens' InitiateAuth AuthFlowType Source #
The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens.USER_SRP_AUTH
takes inUSERNAME
andSRP_A
and returns the SRP variables to be used for next challenge execution.USER_PASSWORD_AUTH
takes inUSERNAME
andPASSWORD
and returns the next challenge or tokens.
Valid values include:
USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol.REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.CUSTOM_AUTH
: Custom authentication flow.USER_PASSWORD_AUTH
: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH
isn't a valid value.
initiateAuth_clientId :: Lens' InitiateAuth Text Source #
The app client ID.
Destructuring the Response
data InitiateAuthResponse Source #
Initiates the authentication response.
See: newInitiateAuthResponse
smart constructor.
InitiateAuthResponse' | |
|
Instances
newInitiateAuthResponse Source #
Create a value of InitiateAuthResponse
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:authenticationResult:InitiateAuthResponse'
, initiateAuthResponse_authenticationResult
- The result of the authentication response. This result is only returned
if the caller doesn't need to pass another challenge. If the caller
does need to pass another challenge before it gets tokens,
ChallengeName
, ChallengeParameters
, and Session
are returned.
InitiateAuthResponse
, initiateAuthResponse_challengeName
- The name of the challenge that you're responding to with this call.
This name is returned in the AdminInitiateAuth
response if you must
pass another challenge.
Valid values include the following:
All of the following challenges require USERNAME
and SECRET_HASH
(if
applicable) in the parameters.
SMS_MFA
: Next challenge is to supply anSMS_MFA_CODE
, delivered via SMS.PASSWORD_VERIFIER
: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after the client-side SRP calculations.CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.DEVICE_SRP_AUTH
: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.DEVICE_PASSWORD_VERIFIER
: Similar toPASSWORD_VERIFIER
, but for devices only.NEW_PASSWORD_REQUIRED
: For users who are required to change their passwords after successful first login.Respond to this challenge with
NEW_PASSWORD
and any required attributes that Amazon Cognito returned in therequiredAttributes
parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.In a
NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API operation to modify the value of any additional attributes.MFA_SETUP
: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parametersMFA_CAN_SETUP
value.To set up software token MFA, use the session returned here from
InitiateAuth
as an input toAssociateSoftwareToken
. Use the session returned byVerifySoftwareToken
as an input toRespondToAuthChallenge
with challenge nameMFA_SETUP
to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should callInitiateAuth
again to restart sign-in.
$sel:challengeParameters:InitiateAuthResponse'
, initiateAuthResponse_challengeParameters
- The challenge parameters. These are returned in the InitiateAuth
response if you must pass another challenge. The responses in this
parameter should be used to compute inputs to the next call
(RespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
$sel:session:InitiateAuthResponse'
, initiateAuthResponse_session
- The session that should pass both ways in challenge-response calls to
the service. If the caller must pass another challenge, they return a
session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge
API call.
$sel:httpStatus:InitiateAuthResponse'
, initiateAuthResponse_httpStatus
- The response's http status code.
Response Lenses
initiateAuthResponse_authenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType) Source #
The result of the authentication response. This result is only returned
if the caller doesn't need to pass another challenge. If the caller
does need to pass another challenge before it gets tokens,
ChallengeName
, ChallengeParameters
, and Session
are returned.
initiateAuthResponse_challengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType) Source #
The name of the challenge that you're responding to with this call.
This name is returned in the AdminInitiateAuth
response if you must
pass another challenge.
Valid values include the following:
All of the following challenges require USERNAME
and SECRET_HASH
(if
applicable) in the parameters.
SMS_MFA
: Next challenge is to supply anSMS_MFA_CODE
, delivered via SMS.PASSWORD_VERIFIER
: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after the client-side SRP calculations.CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.DEVICE_SRP_AUTH
: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.DEVICE_PASSWORD_VERIFIER
: Similar toPASSWORD_VERIFIER
, but for devices only.NEW_PASSWORD_REQUIRED
: For users who are required to change their passwords after successful first login.Respond to this challenge with
NEW_PASSWORD
and any required attributes that Amazon Cognito returned in therequiredAttributes
parameter. You can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.In a
NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theUpdateUserAttributes
API operation to modify the value of any additional attributes.MFA_SETUP
: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parametersMFA_CAN_SETUP
value.To set up software token MFA, use the session returned here from
InitiateAuth
as an input toAssociateSoftwareToken
. Use the session returned byVerifySoftwareToken
as an input toRespondToAuthChallenge
with challenge nameMFA_SETUP
to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should callInitiateAuth
again to restart sign-in.
initiateAuthResponse_challengeParameters :: Lens' InitiateAuthResponse (Maybe (HashMap Text Text)) Source #
The challenge parameters. These are returned in the InitiateAuth
response if you must pass another challenge. The responses in this
parameter should be used to compute inputs to the next call
(RespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
initiateAuthResponse_session :: Lens' InitiateAuthResponse (Maybe Text) Source #
The session that should pass both ways in challenge-response calls to
the service. If the caller must pass another challenge, they return a
session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge
API call.
initiateAuthResponse_httpStatus :: Lens' InitiateAuthResponse Int Source #
The response's http status code.