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

Class: Aws::CognitoIdentityProvider::Types::AdminRespondToAuthChallengeRequest

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 AdminRespondToAuthChallengeRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  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
  challenge_responses: {
    "StringType" => "StringType",
  },
  session: "SessionType",
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
}

The request to respond to the authentication challenge, as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  include Aws::Structure
end

#challenge_nameString

The challenge name. For more information, see .

Returns:

  • (String)


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  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).

  • ADMIN_NO_SRP_AUTH: PASSWORD, 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).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

Returns:

  • (Hash<String,String>)


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  include Aws::Structure
end

#client_idString

The app client ID.

Returns:

  • (String)


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  include Aws::Structure
end

#context_dataTypes::ContextDataType

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.



1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  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)


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  include Aws::Structure
end

#user_pool_idString

The ID of the Amazon Cognito user pool.

Returns:

  • (String)


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1419

class AdminRespondToAuthChallengeRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :challenge_name,
  :challenge_responses,
  :session,
  :analytics_metadata,
  :context_data)
  include Aws::Structure
end