WebAuthnMfaSettingsType - Amazon Cognito User Pools

WebAuthnMfaSettingsType

A user's preference for using passkey, or WebAuthn, multi-factor authentication (MFA). Turns passkey MFA on and off for the user. Unlike other MFA settings types, this type doesn't include a PreferredMfa option because passkey MFA applies only when passkey is the first authentication factor.

This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.

Contents

Enabled

Specifies whether passkey MFA is activated for a user. When activated, the user's passkey authentication requires user verification, and passkey sign-in is available when MFA is required. The user must also have at least one other MFA method such as SMS, TOTP, or email activated to prevent account lockout.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: