WebAuthnConfigurationType ¶

class WebAuthnConfigurationType(TypedDict, closed=True):
    relying_party_id: NotRequired[
        "capo_cognito_identity_provider.types.relying_party_id_type.RelyingPartyIdType"
    ]
    """<p>Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.</p> <p>Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:</p> <ul> <li> <p>The user pool is configured for passkey authentication.</p> </li> <li> <p>The user pool has a custom domain, whether or not it also has a prefix domain.</p> </li> <li> <p>Your application performs authentication with managed login or the classic hosted UI.</p> </li> </ul>"""
    user_verification: NotRequired[
        "capo_cognito_identity_provider.types.user_verification_type.UserVerificationType"
    ]
    """<p>When <code>required</code>, users can only register and sign in users with passkeys that are capable of <a href="https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement">user verification</a>. When <code>preferred</code>, your user pool doesn't require the use of authenticators with user verification but encourages it.</p>"""
    factor_configuration: NotRequired[
        "capo_cognito_identity_provider.types.web_authn_factor_configuration_type.WebAuthnFactorConfigurationType"
    ]
    """<p>Sets whether passkeys can be used as multi-factor authentication (MFA). When set to <code>MULTI_FACTOR_WITH_USER_VERIFICATION</code>, passkey authentication with user verification satisfies MFA requirements. When set to <code>SINGLE_FACTOR</code> or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html"> Essentials tier</a> or higher.</p>"""