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 |
Responds to the authentication challenge.
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 RespondToAuthChallenge = RespondToAuthChallenge' {}
- newRespondToAuthChallenge :: Text -> ChallengeNameType -> RespondToAuthChallenge
- respondToAuthChallenge_analyticsMetadata :: Lens' RespondToAuthChallenge (Maybe AnalyticsMetadataType)
- respondToAuthChallenge_challengeResponses :: Lens' RespondToAuthChallenge (Maybe (HashMap Text Text))
- respondToAuthChallenge_clientMetadata :: Lens' RespondToAuthChallenge (Maybe (HashMap Text Text))
- respondToAuthChallenge_session :: Lens' RespondToAuthChallenge (Maybe Text)
- respondToAuthChallenge_userContextData :: Lens' RespondToAuthChallenge (Maybe UserContextDataType)
- respondToAuthChallenge_clientId :: Lens' RespondToAuthChallenge Text
- respondToAuthChallenge_challengeName :: Lens' RespondToAuthChallenge ChallengeNameType
- data RespondToAuthChallengeResponse = RespondToAuthChallengeResponse' {}
- newRespondToAuthChallengeResponse :: Int -> RespondToAuthChallengeResponse
- respondToAuthChallengeResponse_authenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType)
- respondToAuthChallengeResponse_challengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType)
- respondToAuthChallengeResponse_challengeParameters :: Lens' RespondToAuthChallengeResponse (Maybe (HashMap Text Text))
- respondToAuthChallengeResponse_session :: Lens' RespondToAuthChallengeResponse (Maybe Text)
- respondToAuthChallengeResponse_httpStatus :: Lens' RespondToAuthChallengeResponse Int
Creating a Request
data RespondToAuthChallenge Source #
The request to respond to an authentication challenge.
See: newRespondToAuthChallenge
smart constructor.
RespondToAuthChallenge' | |
|
Instances
newRespondToAuthChallenge Source #
Create a value of RespondToAuthChallenge
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:RespondToAuthChallenge'
, respondToAuthChallenge_analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics
for RespondToAuthChallenge
calls.
RespondToAuthChallenge
, respondToAuthChallenge_challengeResponses
- The challenge responses. These are inputs corresponding to the value of
ChallengeName
, for example:
SECRET_HASH
(if app client is configured with client secret) applies
to all of the inputs that follow (including SOFTWARE_TOKEN_MFA
).
SMS_MFA
:SMS_MFA_CODE
,USERNAME
.PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
.PASSWORD_VERIFIER
requiresDEVICE_KEY
when you sign in with a remembered device.NEW_PASSWORD_REQUIRED
:NEW_PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned asrequiredAttributes
in theInitiateAuth
response, add auserAttributes.
attributename
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.SOFTWARE_TOKEN_MFA
:USERNAME
andSOFTWARE_TOKEN_MFA_CODE
are required attributes.DEVICE_SRP_AUTH
requiresUSERNAME
,DEVICE_KEY
,SRP_A
(andSECRET_HASH
).DEVICE_PASSWORD_VERIFIER
requires everything thatPASSWORD_VERIFIER
requires, plusDEVICE_KEY
.MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.
$sel:clientMetadata:RespondToAuthChallenge'
, respondToAuthChallenge_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 RespondToAuthChallenge API action, Amazon
Cognito invokes any functions that are assigned to the following
triggers: post authentication, pre token generation, /define auth
challenge, create auth challenge, and verify auth challenge/. 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 RespondToAuthChallenge 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.
RespondToAuthChallenge
, respondToAuthChallenge_session
- The session that should be passed both ways in challenge-response calls
to the service. If InitiateAuth
or RespondToAuthChallenge
API call
determines that 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:userContextData:RespondToAuthChallenge'
, respondToAuthChallenge_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.
RespondToAuthChallenge
, respondToAuthChallenge_clientId
- The app client ID.
RespondToAuthChallenge
, respondToAuthChallenge_challengeName
- The challenge name. For more information, see
InitiateAuth.
ADMIN_NO_SRP_AUTH
isn't a valid value.
Request Lenses
respondToAuthChallenge_analyticsMetadata :: Lens' RespondToAuthChallenge (Maybe AnalyticsMetadataType) Source #
The Amazon Pinpoint analytics metadata that contributes to your metrics
for RespondToAuthChallenge
calls.
respondToAuthChallenge_challengeResponses :: Lens' RespondToAuthChallenge (Maybe (HashMap Text Text)) Source #
The challenge responses. These are inputs corresponding to the value of
ChallengeName
, for example:
SECRET_HASH
(if app client is configured with client secret) applies
to all of the inputs that follow (including SOFTWARE_TOKEN_MFA
).
SMS_MFA
:SMS_MFA_CODE
,USERNAME
.PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
.PASSWORD_VERIFIER
requiresDEVICE_KEY
when you sign in with a remembered device.NEW_PASSWORD_REQUIRED
:NEW_PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret). To set any required attributes that Amazon Cognito returned asrequiredAttributes
in theInitiateAuth
response, add auserAttributes.
attributename
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.SOFTWARE_TOKEN_MFA
:USERNAME
andSOFTWARE_TOKEN_MFA_CODE
are required attributes.DEVICE_SRP_AUTH
requiresUSERNAME
,DEVICE_KEY
,SRP_A
(andSECRET_HASH
).DEVICE_PASSWORD_VERIFIER
requires everything thatPASSWORD_VERIFIER
requires, plusDEVICE_KEY
.MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.
respondToAuthChallenge_clientMetadata :: Lens' RespondToAuthChallenge (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 RespondToAuthChallenge API action, Amazon
Cognito invokes any functions that are assigned to the following
triggers: post authentication, pre token generation, /define auth
challenge, create auth challenge, and verify auth challenge/. 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 RespondToAuthChallenge 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.
respondToAuthChallenge_session :: Lens' RespondToAuthChallenge (Maybe Text) Source #
The session that should be passed both ways in challenge-response calls
to the service. If InitiateAuth
or RespondToAuthChallenge
API call
determines that 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.
respondToAuthChallenge_userContextData :: Lens' RespondToAuthChallenge (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.
respondToAuthChallenge_clientId :: Lens' RespondToAuthChallenge Text Source #
The app client ID.
respondToAuthChallenge_challengeName :: Lens' RespondToAuthChallenge ChallengeNameType Source #
The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH
isn't a valid value.
Destructuring the Response
data RespondToAuthChallengeResponse Source #
The response to respond to the authentication challenge.
See: newRespondToAuthChallengeResponse
smart constructor.
RespondToAuthChallengeResponse' | |
|
Instances
newRespondToAuthChallengeResponse Source #
Create a value of RespondToAuthChallengeResponse
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:RespondToAuthChallengeResponse'
, respondToAuthChallengeResponse_authenticationResult
- The result returned by the server in response to the request to respond
to the authentication challenge.
RespondToAuthChallenge
, respondToAuthChallengeResponse_challengeName
- The challenge name. For more information, see
InitiateAuth.
$sel:challengeParameters:RespondToAuthChallengeResponse'
, respondToAuthChallengeResponse_challengeParameters
- The challenge parameters. For more information, see
InitiateAuth.
RespondToAuthChallenge
, respondToAuthChallengeResponse_session
- The session that should be passed 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:RespondToAuthChallengeResponse'
, respondToAuthChallengeResponse_httpStatus
- The response's http status code.
Response Lenses
respondToAuthChallengeResponse_authenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType) Source #
The result returned by the server in response to the request to respond to the authentication challenge.
respondToAuthChallengeResponse_challengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType) Source #
The challenge name. For more information, see InitiateAuth.
respondToAuthChallengeResponse_challengeParameters :: Lens' RespondToAuthChallengeResponse (Maybe (HashMap Text Text)) Source #
The challenge parameters. For more information, see InitiateAuth.
respondToAuthChallengeResponse_session :: Lens' RespondToAuthChallengeResponse (Maybe Text) Source #
The session that should be passed 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.
respondToAuthChallengeResponse_httpStatus :: Lens' RespondToAuthChallengeResponse Int Source #
The response's http status code.