SUsupabase
user

Begin enrolling a new factor for MFA.

Changed on

Starts enrollment of a totp, phone or webauthn factor. Recovery codes are not enrolled through this endpoint; use POST /factors/recovery-codes instead.

post/factors

Request

  • Base URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1
  • URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1/factors
  • Auth
    API key in header apikey and HTTP bearer

Request body

factor_type'totp' | 'phone' | 'webauthn' required
friendly_namestring
issuerstring uri
phonestring phone

Response

A new factor was created in the unverified state. Call `POST /factors/{factorId}/verify' to verify it.

idstring
type'totp' | 'phone' | 'webauthn'
phonestring phone

Changes

  • 4d0f1a6c1ad9Revision changes
    • info

      added the optional property to the response with the status

  • f89bf040698fRevision changes
    • warning

      added the new webauthn enum value to the response property for the response status

    • info

      added the new webauthn enum value to the request property