Class: Aws::CognitoIdentityProvider::Types::DeviceConfigurationType

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::DeviceConfigurationType

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The device-remembering configuration for a user pool.

When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#challenge_required_on_new_device ⇒ Boolean
When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
#device_only_remembered_on_user_prompt ⇒ Boolean
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.

Instance Attribute Details

#challenge_required_on_new_device ⇒ `Boolean`

When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

Returns:

(Boolean)

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

class DeviceConfigurationType < Struct.new(
  :challenge_required_on_new_device,
  :device_only_remembered_on_user_prompt)
  SENSITIVE = []
  include Aws::Structure
end

#device_only_remembered_on_user_prompt ⇒ `Boolean`

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.