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

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

Overview

Responds to the authentication challenge, as an administrator.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_resultTypes::AuthenticationResultType

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



1855
1856
1857
1858
1859
1860
1861
1862
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminRespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = []
  include Aws::Structure
end

#challenge_nameString

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

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminRespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = []
  include Aws::Structure
end

#challenge_parametersHash<String,String>

The challenge parameters. For more information, see AdminInitiateAuth.

Returns:

  • (Hash<String,String>)


1855
1856
1857
1858
1859
1860
1861
1862
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminRespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = []
  include Aws::Structure
end

#sessionString

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

Returns:

  • (String)


1855
1856
1857
1858
1859
1860
1861
1862
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1855

class AdminRespondToAuthChallengeResponse < Struct.new(
  :challenge_name,
  :session,
  :challenge_parameters,
  :authentication_result)
  SENSITIVE = []
  include Aws::Structure
end