Skip to main content
POST
Initiate MFA Setup

Autorizaciones

Authorization
string
header
requerido

The authorization token in the 'Bearer ' format.

Parámetros de ruta

id
string
requerido

The unique identifier of the user you want to retrieve.

Cuerpo

application/json

Information required to initiate MFA setup for a user.

mfaType
enum<string>
requerido

The type of MFA to configure.

Opciones disponibles:
app,
email,
sms

Respuesta

MFA setup initiated successfully. Store the secret and recovery codes before proceeding to verification.

The result of an MFA setup initiation, including the secret and recovery codes.

secret
string

TOTP secret to be stored securely by the user or app.

url
string

OTP Auth URL for QR code generation (TOTP only).

recoveryCodes
string[]

One-time recovery codes to be stored by the user.

mfaType
enum<string>

The MFA type that was configured.

Opciones disponibles:
app,
email,
sms
enabled
boolean

Indicates whether MFA is currently enabled.