Class: Aws::CognitoIdentityProvider::Types::RespondToAuthChallengeRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::RespondToAuthChallengeRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
The request to respond to an authentication challenge.
Constant Summary collapse
- SENSITIVE =
[:client_id, :session, :challenge_responses, :user_context_data]
Instance Attribute Summary collapse
-
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘RespondToAuthChallenge` calls.
-
#challenge_name ⇒ String
The challenge name.
-
#challenge_responses ⇒ Hash<String,String>
The responses to the challenge that you received in the previous request.
-
#client_id ⇒ String
The app client ID.
-
#client_metadata ⇒ Hash<String,String>
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
-
#session ⇒ String
The session that should be passed both ways in challenge-response calls to the service.
-
#user_context_data ⇒ Types::UserContextDataType
Contextual data about your user session, such as the device fingerprint, IP address, or location.
Instance Attribute Details
#analytics_metadata ⇒ Types::AnalyticsMetadataType
The Amazon Pinpoint analytics metadata that contributes to your metrics for ‘RespondToAuthChallenge` calls.
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#challenge_name ⇒ String
The challenge name. For more information, see [InitiateAuth].
‘ADMIN_NO_SRP_AUTH` isn’t a valid value.
[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#challenge_responses ⇒ Hash<String,String>
The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.
You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret. Include a ‘DEVICE_KEY` for device authentication.
SELECT_CHALLENGE
: ‘“ChallengeName”: “SELECT_CHALLENGE”, “ChallengeResponses”:
"USERNAME": "[username]", "ANSWER": "[Challenge name]"`
Available challenges are `PASSWORD`, `PASSWORD_SRP`, `EMAIL_OTP`,
`SMS_OTP`, and `WEB_AUTHN`.
Complete authentication in the `SELECT_CHALLENGE` response for
`PASSWORD`, `PASSWORD_SRP`, and `WEB_AUTHN`:
* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
"ANSWER": "WEB_AUTHN", "USERNAME": "[username]", "CREDENTIAL":
"[AuthenticationResponseJSON]"}`
See [ AuthenticationResponseJSON][1].
* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
"ANSWER": "PASSWORD", "USERNAME": "[username]", "PASSWORD":
"[password]"}`
* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
"ANSWER": "PASSWORD_SRP", "USERNAME": "[username]", "SRP_A":
"[SRP_A]"}`
For `SMS_OTP` and `EMAIL_OTP`, respond with the username and
answer. Your user pool will send a code for the user to submit in
the next challenge response.
* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
"ANSWER": "SMS_OTP", "USERNAME": "[username]"}`
* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
"ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`
SMS_OTP
: ‘“ChallengeName”: “SMS_OTP”, “ChallengeResponses”:
"[code]", "USERNAME": "[username]"`
EMAIL_OTP
: ‘“ChallengeName”: “EMAIL_OTP”, “ChallengeResponses”:
"[code]", "USERNAME": "[username]"`
SMS_MFA
: ‘“ChallengeName”: “SMS_MFA”, “ChallengeResponses”:
"[code]", "USERNAME": "[username]"`
PASSWORD_VERIFIER
: This challenge response is part of the SRP flow. Amazon Cognito
requires that your application respond to this challenge within a
few seconds. When the response time exceeds this period, your user
pool returns a `NotAuthorizedException` error.
`"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
"[claim_signature]",
"PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
[timestamp], "USERNAME": "[username]"`
Add `"DEVICE_KEY"` when you sign in with a remembered device.
CUSTOM_CHALLENGE
: ‘“ChallengeName”: “CUSTOM_CHALLENGE”, “ChallengeResponses”:
"[username]", "ANSWER": "[challenge_answer]"`
Add `"DEVICE_KEY"` when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED
: ‘“ChallengeName”: “NEW_PASSWORD_REQUIRED”, “ChallengeResponses”:
"[new_password]", "USERNAME": "[username]"`
To set any required attributes that `InitiateAuth` returned in an
`requiredAttributes` parameter, add
`"userAttributes.[attribute_name]": "[attribute_value]"`. This
parameter can also set values for writable attributes that aren't
required by your user pool.
<note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify
a required attribute that already has a value. In
`RespondToAuthChallenge`, set a value for any keys that Amazon
Cognito returned in the `requiredAttributes` parameter, then use
the `UpdateUserAttributes` API operation to modify the value of
any additional attributes.
</note>
SOFTWARE_TOKEN_MFA
: ‘“ChallengeName”: “SOFTWARE_TOKEN_MFA”, “ChallengeResponses”:
"[username]", "SOFTWARE_TOKEN_MFA_CODE":
[authenticator_code]`
DEVICE_SRP_AUTH
: ‘“ChallengeName”: “DEVICE_SRP_AUTH”, “ChallengeResponses”:
"[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
"[srp_a]"`
DEVICE_PASSWORD_VERIFIER
: ‘“ChallengeName”: “DEVICE_PASSWORD_VERIFIER”,
"ChallengeResponses": "[device_key]",
"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
"PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
[timestamp], "USERNAME": "[username]"`
MFA_SETUP
: ‘“ChallengeName”: “MFA_SETUP”, “ChallengeResponses”: {“USERNAME”:
"[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"`
SELECT_MFA_TYPE
: ‘“ChallengeName”: “SELECT_MFA_TYPE”, “ChallengeResponses”:
{"USERNAME": "[username]", "ANSWER": "[SMS_MFA or
SOFTWARE_TOKEN_MFA]"}`
For more information about ‘SECRET_HASH`, see [Computing secret hash values]. For information about `DEVICE_KEY`, see [Working with user devices in your user pool].
[1]: www.w3.org/TR/webauthn-3/#dictdef-authenticationresponsejson [2]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#client_id ⇒ String
The app client ID.
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#client_metadata ⇒ Hash<String,String>
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*.
<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note 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 send sensitive information in this parameter.
</note>
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#session ⇒ String
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.
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |
#user_context_data ⇒ Types::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.
For more information, see [Collecting data for threat protection in applications].
9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 9341 class RespondToAuthChallengeRequest < Struct.new( :client_id, :challenge_name, :session, :challenge_responses, :analytics_metadata, :user_context_data, :client_metadata) SENSITIVE = [:client_id, :session, :challenge_responses, :user_context_data] include Aws::Structure end |