Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Documentation

data DeviceConfigurationType

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

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

See: newDeviceConfigurationType smart constructor.

Constructors

DeviceConfigurationType'

Fields

• challengeRequiredOnNewDevice :: Maybe Bool

  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.

• deviceOnlyRememberedOnUserPrompt :: Maybe Bool

  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.

Instances

FromJSON DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

parseJSON :: Value -> Parser DeviceConfigurationType

parseJSONList :: Value -> Parser [DeviceConfigurationType]

ToJSON DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

toJSON :: DeviceConfigurationType -> Value

toEncoding :: DeviceConfigurationType -> Encoding

toJSONList :: [DeviceConfigurationType] -> Value

toEncodingList :: [DeviceConfigurationType] -> Encoding

Generic DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Associated Types

type Rep DeviceConfigurationType :: Type -> Type

Methods

from :: DeviceConfigurationType -> Rep DeviceConfigurationType x

to :: Rep DeviceConfigurationType x -> DeviceConfigurationType

Read DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

readsPrec :: Int -> ReadS DeviceConfigurationType

readList :: ReadS [DeviceConfigurationType]

readPrec :: ReadPrec DeviceConfigurationType

readListPrec :: ReadPrec [DeviceConfigurationType]

Show DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

showsPrec :: Int -> DeviceConfigurationType -> ShowS

show :: DeviceConfigurationType -> String

showList :: [DeviceConfigurationType] -> ShowS

NFData DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

rnf :: DeviceConfigurationType -> ()

Eq DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

(==) :: DeviceConfigurationType -> DeviceConfigurationType -> Bool

(/=) :: DeviceConfigurationType -> DeviceConfigurationType -> Bool

Hashable DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

Methods

hashWithSalt :: Int -> DeviceConfigurationType -> Int

hash :: DeviceConfigurationType -> Int

type Rep DeviceConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType

type Rep DeviceConfigurationType = D1 ('MetaData "DeviceConfigurationType" "Amazonka.CognitoIdentityProvider.Types.DeviceConfigurationType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "DeviceConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "challengeRequiredOnNewDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "deviceOnlyRememberedOnUserPrompt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newDeviceConfigurationType :: DeviceConfigurationType

Create a value of DeviceConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:challengeRequiredOnNewDevice:DeviceConfigurationType', deviceConfigurationType_challengeRequiredOnNewDevice - 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.

$sel:deviceOnlyRememberedOnUserPrompt:DeviceConfigurationType', deviceConfigurationType_deviceOnlyRememberedOnUserPrompt - 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.

deviceConfigurationType_challengeRequiredOnNewDevice :: Lens' DeviceConfigurationType (Maybe Bool)

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.

deviceConfigurationType_deviceOnlyRememberedOnUserPrompt :: Lens' DeviceConfigurationType (Maybe Bool)

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.