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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass RespondToAuthChallengeRequest data as a hash:

{
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
  session: "SessionType",
  challenge_responses: {
    "StringType" => "StringType",
  },
}

The request to respond to an authentication challenge.

Instance Attribute Summary collapse

Instance Attribute Details

#challenge_nameString

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH is not a valid value.

Returns:

  • (String)


4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4422

class RespondToAuthChallengeRequest < Struct.new(
  :client_id,
  :challenge_name,
  :session,
  :challenge_responses)
  include Aws::Structure
end

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


4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4422

class RespondToAuthChallengeRequest < Struct.new(
  :client_id,
  :challenge_name,
  :session,
  :challenge_responses)
  include Aws::Structure
end

#client_idString

The app client ID.

Returns:

  • (String)


4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4422

class RespondToAuthChallengeRequest < Struct.new(
  :client_id,
  :challenge_name,
  :session,
  :challenge_responses)
  include Aws::Structure
end

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


4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4422

class RespondToAuthChallengeRequest < Struct.new(
  :client_id,
  :challenge_name,
  :session,
  :challenge_responses)
  include Aws::Structure
end