Class: Aws::CognitoIdentityProvider::Types::InitiateAuthResponse

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::InitiateAuthResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Initiates the authentication response.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:session]

Instance Attribute Summary

• #authentication_result ⇒ Types::AuthenticationResultType

  The result of the authentication response.

• #challenge_name ⇒ String

  The name of the challenge that you’re responding to with this call.

• #challenge_parameters ⇒ Hash<String,String>

  The challenge parameters.

• #session ⇒ String

  The session that should pass both ways in challenge-response calls to the service.

Instance Attribute Details

#authentication_result ⇒ Types::AuthenticationResultType

The result of the authentication response. This result is only returned if the caller doesn’t need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ‘ChallengeName`, `ChallengeParameters`, and `Session` are returned.

Returns:

• (Types::AuthenticationResultType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5674

class InitiateAuthResponse < 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’re responding to with this call. This name is returned in the ‘InitiateAuth` response if you must pass another challenge.

Valid values include the following:

<note markdown=“1”> All of the following challenges require ‘USERNAME` and `SECRET_HASH` (if applicable) in the parameters.

</note>

• ‘SMS_MFA`: Next challenge is to supply an `SMS_MFA_CODE`, delivered via SMS.

• ‘PASSWORD_VERIFIER`: Next challenge is to supply `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after the client-side SRP calculations.

• ‘CUSTOM_CHALLENGE`: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

• ‘DEVICE_SRP_AUTH`: If device tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

• ‘DEVICE_PASSWORD_VERIFIER`: Similar to `PASSWORD_VERIFIER`, but for devices only.

• ‘NEW_PASSWORD_REQUIRED`: For users who are required to change their passwords after successful first login.

  Respond to this challenge with ‘NEW_PASSWORD` and any required attributes that Amazon Cognito returned in the `requiredAttributes` parameter. You can also set values for attributes that aren’t required by your user pool and that your app client can write. For more information, see [RespondToAuthChallenge].

  <note markdown=“1”> In a ‘NEW_PASSWORD_REQUIRED` challenge response, you can’t modify a required attribute that already has a value. In ‘RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `UpdateUserAttributes` API operation to modify the value of any additional attributes.

  </note>
  

• ‘MFA_SETUP`: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters `MFAS_CAN_SETUP` value.

  To set up software token MFA, use the session returned here from ‘InitiateAuth` as an input to `AssociateSoftwareToken`. Use the session returned by `VerifySoftwareToken` as an input to `RespondToAuthChallenge` with challenge name `MFA_SETUP` to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call `InitiateAuth` again to restart sign-in.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5674

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

#challenge_parameters ⇒ Hash<String,String>

The challenge parameters. These are returned in the ‘InitiateAuth` response if you must pass another challenge. The responses in this parameter should be used to compute inputs to the next call (`RespondToAuthChallenge`).

All challenges require ‘USERNAME` and `SECRET_HASH` (if applicable).

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5674

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

#session ⇒ String

The session that should pass 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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5674

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