Skip to content

DeviceConfigurationType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/device_configuration_type.py 
11
12
13
14
15
16
17
18
19
class DeviceConfigurationType(TypedDict, closed=True):
    challenge_required_on_new_device: (
        "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    )
    """<p>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).</p> <note> <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> 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.</p> </note>"""
    device_only_remembered_on_user_prompt: (
        "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    )
    """<p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a <code>ConfirmDevice</code> 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 <code>UpdateDeviceStatus</code> API request.</p> <p>When <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>false</code>, Amazon Cognito immediately remembers devices that you register in a <code>ConfirmDevice</code> API request.</p>"""

challenge_required_on_new_device instance-attribute 

challenge_required_on_new_device: BooleanType

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.

device_only_remembered_on_user_prompt instance-attribute 

device_only_remembered_on_user_prompt: BooleanType

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.