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

Inherits:

Struct

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

show all

Includes:: Structure

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

Overview

The device-remembering configuration for a user pool. A [ DescribeUserPool] request returns a null value for this object when the user pool isn’t configured to remember devices. When device remembering is active, you can remember a user’s device with a

ConfirmDevice][2: API request. Additionally. when the property

‘DeviceOnlyRememberedOnUserPrompt` is `true`, you must follow `ConfirmDevice` with an [UpdateDeviceStatus] API request that sets the user’s device to ‘remembered` or `not_remembered`.

To sign in with a remembered device, include ‘DEVICE_KEY` in the authentication parameters in your user’s [ InitiateAuth] request. If your app doesn’t include a ‘DEVICE_KEY` parameter, the

response][5: from Amazon Cognito includes newly-generated

‘DEVICE_KEY` and `DEVICE_GROUP_KEY` values under `NewDeviceMetadata`. Store these values to use in future device-authentication requests.

<note markdown=“1”> When you provide a value for any property of ‘DeviceConfiguration`, you activate the device remembering for the user pool.

This data type is a request and response parameter of

CreateUserPool][6: and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

</note>

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html [5]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax [6]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [7]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html

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).

<note markdown=“1”> 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.

</note>

Returns:

(Boolean)

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

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.

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