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

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

Overview

Responds to the authentication challenge, as an administrator.

See Also:

Constant Summary collapse

SENSITIVE = 
[:session]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_result ⇒ Types::AuthenticationResultType

The outcome of a successful authentication process. After your application has passed all challenges, Amazon Cognito returns an ‘AuthenticationResult` with the JSON web tokens (JWTs) that indicate successful sign-in.

Returns:



1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1987

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

#challenge_name ⇒ String

The name of the challenge that you must next respond to. You can find more information about values for ‘ChallengeName` in the response parameters of [AdminInitiateAuth].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html#CognitoUserPools-AdminInitiateAuth-response-ChallengeName

Returns:

  • (String) 


1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1987

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

#challenge_parameters ⇒ Hash<String,String>

The parameters that define your response to the next challenge. Take the values in ‘ChallengeParameters` and provide values for them in the [ChallengeResponses] of the next `AdminRespondToAuthChallenge` request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html#CognitoUserPools-AdminRespondToAuthChallenge-request-ChallengeResponses

Returns:

  • (Hash<String,String>) 


1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1987

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

#session ⇒ String

The session identifier that maintains the state of authentication requests and challenge responses. If an ‘AdminInitiateAuth` or `AdminRespondToAuthChallenge` API request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the next `AdminRespondToAuthChallenge` request.

Returns:

  • (String) 


1987
1988
1989
1990
1991
1992
1993
1994
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1987

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