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

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

Overview

Initiates the authentication response.

See Also:

Constant Summary collapse

SENSITIVE = 
[:session]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_result ⇒ Types::AuthenticationResultType

The result of a successful and complete authentication request. This result is only returned if the user doesn’t need to pass another challenge. If they must pass another challenge before they get tokens, Amazon Cognito returns a challenge in ‘ChallengeName`, `ChallengeParameters`, and `Session` response parameters.

Returns:



7211
7212
7213
7214
7215
7216
7217
7218
7219
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7211

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

#available_challenges ⇒ Array<String>

This response parameter lists the available authentication challenges that users can select from in [choice-based authentication]. For example, they might be able to choose between passkey authentication, a one-time password from an SMS message, and a traditional password.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice

Returns:

  • (Array<String>) 


7211
7212
7213
7214
7215
7216
7217
7218
7219
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7211

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

#challenge_name ⇒ String

The name of an additional authentication challenge that you must respond to.

Possible challenges include the following:

<note markdown=“1”> All of the following challenges require ‘USERNAME` and, when the app client has a client secret, `SECRET_HASH` in the parameters.

</note>

  • ‘WEB_AUTHN`: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey. Examples of WebAuthn authenticators include biometric devices and security keys.

  • ‘PASSWORD`: Respond with `USER_PASSWORD_AUTH` parameters: `USERNAME` (required), `PASSWORD` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.

  • ‘PASSWORD_SRP`: Respond with `USER_SRP_AUTH` parameters: `USERNAME` (required), `SRP_A` (required), `SECRET_HASH` (required if the app client is configured with a client secret), `DEVICE_KEY`.

  • ‘SELECT_CHALLENGE`: Respond to the challenge with `USERNAME` and an `ANSWER` that matches one of the challenge types in the `AvailableChallenges` response parameter.

  • ‘SMS_MFA`: Respond with an `SMS_MFA_CODE` that your user pool delivered in an SMS message.

  • ‘EMAIL_OTP`: Respond with an `EMAIL_OTP_CODE` that your user pool delivered in an email message.

  • ‘PASSWORD_VERIFIER`: Respond with `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after 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. The parameters of the challenge are determined by your Lambda function.

  • ‘DEVICE_SRP_AUTH`: Respond with the initial parameters of device SRP authentication. For more information, see [Signing in with a device].

  • ‘DEVICE_PASSWORD_VERIFIER`: Respond with `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after client-side SRP calculations. For more information, see [Signing in with a device].

  • ‘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.

    Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes.

    <note markdown=“1”> In a ‘NEW_PASSWORD_REQUIRED` challenge response, you can’t modify a required attribute that already has a value. In ‘AdminRespondToAuthChallenge` or `RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `AdminUpdateUserAttributes` or `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 time-based one-time password (TOTP) MFA, use the session returned in this challenge from ‘InitiateAuth` or `AdminInitiateAuth` as an input to `AssociateSoftwareToken`. Then, use the session returned by `VerifySoftwareToken` as an input to `RespondToAuthChallenge` or `AdminRespondToAuthChallenge` with challenge name `MFA_SETUP` to complete sign-in.

    To set up SMS or email MFA, collect a ‘phone_number` or `email` attribute for the user. Then restart the authentication flow with an `InitiateAuth` or `AdminInitiateAuth` request.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device

Returns:

  • (String) 


7211
7212
7213
7214
7215
7216
7217
7218
7219
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7211

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

#challenge_parameters ⇒ Hash<String,String>

The required parameters of the ‘ChallengeName` challenge.

All challenges require ‘USERNAME`. They also require `SECRET_HASH` if your app client has a client secret.

Returns:

  • (Hash<String,String>) 


7211
7212
7213
7214
7215
7216
7217
7218
7219
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7211

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

#session ⇒ String

The session identifier that links a challenge response to the initial authentication request. If the user must pass another challenge, Amazon Cognito returns a session ID and challenge parameters.

Returns:

  • (String) 


7211
7212
7213
7214
7215
7216
7217
7218
7219
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7211

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