SUsupabase
user

Get the status of the user's MFA recovery codes.

Changed on

Returns the recovery-code factor ID together with the total number of codes and how many are still unused. Code values are never returned after generation. Works regardless of whether recovery-code enrollment or verification is enabled on the server.

get/factors/recovery-codes

Request

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

Response

The user's recovery-code status.

idstring uuid

ID of the user's recovery_code factor.

typestring

Always recovery_code.

totalinteger

Number of codes in the current set.

remaininginteger

Number of codes in the current set that have not been used yet.

Example response

{
  "total": 10,
  "remaining": 9
}

Changes