You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::RespondToAuthChallengeRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RespondToAuthChallengeRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
  session: "SessionType",
  challenge_responses: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    encoded_data: "StringType",
  },
}

The request to respond to an authentication challenge.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

Returns:

#challenge_nameString

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

Possible values:

  • SMS_MFA
  • SOFTWARE_TOKEN_MFA
  • SELECT_MFA_TYPE
  • MFA_SETUP
  • PASSWORD_VERIFIER
  • CUSTOM_CHALLENGE
  • DEVICE_SRP_AUTH
  • DEVICE_PASSWORD_VERIFIER
  • ADMIN_NO_SRP_AUTH
  • NEW_PASSWORD_REQUIRED

Returns:

  • (String)

    The challenge name.

#challenge_responsesHash<String,String>

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

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

Returns:

  • (Hash<String,String>)

    The challenge responses.

#client_idString

The app client ID.

Returns:

  • (String)

    The app client ID.

#sessionString

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Returns:

  • (String)

    The session which should be passed both ways in challenge-response calls to the service.

#user_context_dataTypes::UserContextDataType

Contextual data such as the user\'s device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

  • (Types::UserContextDataType)

    Contextual data such as the user\'s device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.