Initiate MFA Setup

Initiates MFA setup for a user. Returns QR code URL and secret for TOTP, or sends a verification code for email.

POST /v1/users/{id}/mfa/setup

Error

A valid request URL is required to generate request examples

200

{
  "mfaType": "app",
  "secret": "JBSWY3DPEHPK3PXP",
  "enabled": true,
  "recoveryCodes": [
    "recoveryCodes",
    "recoveryCodes"
  ],
  "url": "otpauth://totp/..."
}

Autorizaciones

Authorization · string · header · requerido

Bearer authentication. Send Authorization: Bearer .

Parámetros de ruta

id · string · requerido

User ID

Cuerpo

application/json

MFA Setup Input

MFASetupInput payload

mfaType · enum<string> · requerido

MFA type: "app" (TOTP) or "email"

Opciones disponibles: app, email

Ejemplo:

"app"

Respuesta

200

application/json

OK

MFASetupResponse payload

enabled · boolean

Whether MFA was already enabled

mfaType · string

Configured MFA type

Ejemplo:

"app"

recoveryCodes · string[]

Recovery codes (store in a safe place)

secret · string

Secret for manual TOTP configuration

Ejemplo:

"JBSWY3DPEHPK3PXP"

url · string

otpauth URL for QR code (TOTP only)

Ejemplo:

"otpauth://totp/..."