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 an authentication challenge, as an administrator.
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.
Calling this action requires developer credentials.
Synopsis
- data AdminRespondToAuthChallenge = AdminRespondToAuthChallenge' {}
- newAdminRespondToAuthChallenge :: Text -> Text -> ChallengeNameType -> AdminRespondToAuthChallenge
- adminRespondToAuthChallenge_analyticsMetadata :: Lens' AdminRespondToAuthChallenge (Maybe AnalyticsMetadataType)
- adminRespondToAuthChallenge_challengeResponses :: Lens' AdminRespondToAuthChallenge (Maybe (HashMap Text Text))
- adminRespondToAuthChallenge_clientMetadata :: Lens' AdminRespondToAuthChallenge (Maybe (HashMap Text Text))
- adminRespondToAuthChallenge_contextData :: Lens' AdminRespondToAuthChallenge (Maybe ContextDataType)
- adminRespondToAuthChallenge_session :: Lens' AdminRespondToAuthChallenge (Maybe Text)
- adminRespondToAuthChallenge_userPoolId :: Lens' AdminRespondToAuthChallenge Text
- adminRespondToAuthChallenge_clientId :: Lens' AdminRespondToAuthChallenge Text
- adminRespondToAuthChallenge_challengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType
- data AdminRespondToAuthChallengeResponse = AdminRespondToAuthChallengeResponse' {}
- newAdminRespondToAuthChallengeResponse :: Int -> AdminRespondToAuthChallengeResponse
- adminRespondToAuthChallengeResponse_authenticationResult :: Lens' AdminRespondToAuthChallengeResponse (Maybe AuthenticationResultType)
- adminRespondToAuthChallengeResponse_challengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType)
- adminRespondToAuthChallengeResponse_challengeParameters :: Lens' AdminRespondToAuthChallengeResponse (Maybe (HashMap Text Text))
- adminRespondToAuthChallengeResponse_session :: Lens' AdminRespondToAuthChallengeResponse (Maybe Text)
- adminRespondToAuthChallengeResponse_httpStatus :: Lens' AdminRespondToAuthChallengeResponse Int
Creating a Request
data AdminRespondToAuthChallenge Source #
The request to respond to the authentication challenge, as an administrator.
See: newAdminRespondToAuthChallenge
smart constructor.
AdminRespondToAuthChallenge' | |
|
Instances
newAdminRespondToAuthChallenge Source #
Create a value of AdminRespondToAuthChallenge
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:AdminRespondToAuthChallenge'
, adminRespondToAuthChallenge_analyticsMetadata
- The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge
calls.
AdminRespondToAuthChallenge
, adminRespondToAuthChallenge_challengeResponses
- The challenge responses. These are inputs corresponding to the value of
ChallengeName
, for example:
SMS_MFA
:SMS_MFA_CODE
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).PASSWORD_VERIFIER
requiresDEVICE_KEY
when signing in with a remembered device.ADMIN_NO_SRP_AUTH
:PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).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 theAdminInitiateAuth
response, add auserAttributes.
attributename
In a
NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InAdminRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theAdminUpdateUserAttributes
API operation to modify the value of any additional attributes.MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.
The value of the USERNAME
attribute must be the user's actual
username, not an alias (such as an email address or phone number). To
make this simpler, the AdminInitiateAuth
response includes the actual
username value in the USERNAMEUSER_ID_FOR_SRP
attribute. This happens
even if you specified an alias in your call to AdminInitiateAuth
.
$sel:clientMetadata:AdminRespondToAuthChallenge'
, adminRespondToAuthChallenge_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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
- pre sign-up
- custom message
- post authentication
- user migration
- pre token generation
- define auth challenge
- create auth challenge
- verify auth challenge response
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 that provides the data that you assigned to
the ClientMetadata parameter in your AdminRespondToAuthChallenge
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:contextData:AdminRespondToAuthChallenge'
, adminRespondToAuthChallenge_contextData
- 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.
AdminRespondToAuthChallenge
, adminRespondToAuthChallenge_session
- The session that should be passed both ways in challenge-response calls
to the service. If an InitiateAuth
or RespondToAuthChallenge
API
call determines that the caller must pass another challenge, it returns
a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge
API call.
AdminRespondToAuthChallenge
, adminRespondToAuthChallenge_userPoolId
- The ID of the Amazon Cognito user pool.
AdminRespondToAuthChallenge
, adminRespondToAuthChallenge_clientId
- The app client ID.
AdminRespondToAuthChallenge
, adminRespondToAuthChallenge_challengeName
- The challenge name. For more information, see
AdminInitiateAuth.
Request Lenses
adminRespondToAuthChallenge_analyticsMetadata :: Lens' AdminRespondToAuthChallenge (Maybe AnalyticsMetadataType) Source #
The analytics metadata for collecting Amazon Pinpoint metrics for
AdminRespondToAuthChallenge
calls.
adminRespondToAuthChallenge_challengeResponses :: Lens' AdminRespondToAuthChallenge (Maybe (HashMap Text Text)) Source #
The challenge responses. These are inputs corresponding to the value of
ChallengeName
, for example:
SMS_MFA
:SMS_MFA_CODE
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).PASSWORD_VERIFIER
:PASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
,TIMESTAMP
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).PASSWORD_VERIFIER
requiresDEVICE_KEY
when signing in with a remembered device.ADMIN_NO_SRP_AUTH
:PASSWORD
,USERNAME
,SECRET_HASH
(if app client is configured with client secret).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 theAdminInitiateAuth
response, add auserAttributes.
attributename
In a
NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. InAdminRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theAdminUpdateUserAttributes
API operation to modify the value of any additional attributes.MFA_SETUP
requiresUSERNAME
, plus you must use the session value returned byVerifySoftwareToken
in theSession
parameter.
The value of the USERNAME
attribute must be the user's actual
username, not an alias (such as an email address or phone number). To
make this simpler, the AdminInitiateAuth
response includes the actual
username value in the USERNAMEUSER_ID_FOR_SRP
attribute. This happens
even if you specified an alias in your call to AdminInitiateAuth
.
adminRespondToAuthChallenge_clientMetadata :: Lens' AdminRespondToAuthChallenge (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 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
- pre sign-up
- custom message
- post authentication
- user migration
- pre token generation
- define auth challenge
- create auth challenge
- verify auth challenge response
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 that provides the data that you assigned to
the ClientMetadata parameter in your AdminRespondToAuthChallenge
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.
adminRespondToAuthChallenge_contextData :: Lens' AdminRespondToAuthChallenge (Maybe ContextDataType) 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.
adminRespondToAuthChallenge_session :: Lens' AdminRespondToAuthChallenge (Maybe Text) Source #
The session that should be passed both ways in challenge-response calls
to the service. If an InitiateAuth
or RespondToAuthChallenge
API
call determines that the caller must pass another challenge, it returns
a session with other challenge parameters. This session should be passed
as it is to the next RespondToAuthChallenge
API call.
adminRespondToAuthChallenge_userPoolId :: Lens' AdminRespondToAuthChallenge Text Source #
The ID of the Amazon Cognito user pool.
adminRespondToAuthChallenge_clientId :: Lens' AdminRespondToAuthChallenge Text Source #
The app client ID.
adminRespondToAuthChallenge_challengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType Source #
The challenge name. For more information, see AdminInitiateAuth.
Destructuring the Response
data AdminRespondToAuthChallengeResponse Source #
Responds to the authentication challenge, as an administrator.
See: newAdminRespondToAuthChallengeResponse
smart constructor.
AdminRespondToAuthChallengeResponse' | |
|
Instances
newAdminRespondToAuthChallengeResponse Source #
Create a value of AdminRespondToAuthChallengeResponse
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:AdminRespondToAuthChallengeResponse'
, adminRespondToAuthChallengeResponse_authenticationResult
- The result returned by the server in response to the authentication
request.
AdminRespondToAuthChallenge
, adminRespondToAuthChallengeResponse_challengeName
- The name of the challenge. For more information, see
AdminInitiateAuth.
$sel:challengeParameters:AdminRespondToAuthChallengeResponse'
, adminRespondToAuthChallengeResponse_challengeParameters
- The challenge parameters. For more information, see
AdminInitiateAuth.
AdminRespondToAuthChallenge
, adminRespondToAuthChallengeResponse_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:AdminRespondToAuthChallengeResponse'
, adminRespondToAuthChallengeResponse_httpStatus
- The response's http status code.
Response Lenses
adminRespondToAuthChallengeResponse_authenticationResult :: Lens' AdminRespondToAuthChallengeResponse (Maybe AuthenticationResultType) Source #
The result returned by the server in response to the authentication request.
adminRespondToAuthChallengeResponse_challengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType) Source #
The name of the challenge. For more information, see AdminInitiateAuth.
adminRespondToAuthChallengeResponse_challengeParameters :: Lens' AdminRespondToAuthChallengeResponse (Maybe (HashMap Text Text)) Source #
The challenge parameters. For more information, see AdminInitiateAuth.
adminRespondToAuthChallengeResponse_session :: Lens' AdminRespondToAuthChallengeResponse (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.
adminRespondToAuthChallengeResponse_httpStatus :: Lens' AdminRespondToAuthChallengeResponse Int Source #
The response's http status code.