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

Class: Aws::CognitoIdentityProvider::Types::AdminRespondToAuthChallengeResponse

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

Overview

Responds to the authentication challenge, as an administrator.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_resultTypes::AuthenticationResultType

The result returned by the server in response to the authentication request.

Returns:

#challenge_nameString

The name of the challenge. For more information, see AdminInitiateAuth.

Possible values:

  • SMS_MFA
  • PASSWORD_VERIFIER
  • CUSTOM_CHALLENGE
  • DEVICE_SRP_AUTH
  • DEVICE_PASSWORD_VERIFIER
  • ADMIN_NO_SRP_AUTH
  • NEW_PASSWORD_REQUIRED

Returns:

  • (String)

    The name of the challenge.

#challenge_parametersHash<String,String>

The challenge parameters. For more information, see AdminInitiateAuth.

Returns:

  • (Hash<String,String>)

    The challenge parameters.

#sessionString

The session which should be passed both ways in challenge-response calls to the service. If the 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.