Users

Set WebAuthn two-factor authentication

Changed on

Choose whether registered passkeys are required as a second factor when signing in with email and password. Enabling requires at least one registered credential and mints backup codes when the account has none. Requires sudo mode verification.

put/users/@me/mfa/webauthn/two-factor

Request

Request body

enabledboolean required

Whether registered passkeys count as a second factor when logging in

passwordstring
mfa_method'totp' | 'webauthn' | 'email_code'

MFA method to use for verification

mfa_codestring

MFA verification code from an authenticator app

email_code_ticketstring

Ticket from POST /users/@me/sudo/email-code, sent with mfa_method email_code

email_codestring

The 6-digit code from the email, sent with mfa_method email_code

webauthn_challengestring

WebAuthn challenge string

Response

Success

Changes

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status