Skip to main content
POST
Initiate MFA Setup

Autorizações

Authorization
string
header
obrigatório

The authorization token in the 'Bearer ' format.

Parâmetros de caminho

id
string
obrigatório

The unique identifier of the user you want to retrieve.

Corpo

application/json

Information required to initiate MFA setup for a user.

mfaType
enum<string>
obrigatório

The type of MFA to configure.

Opções disponíveis:
app,
email,
sms

Resposta

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.

Opções disponíveis:
app,
email,
sms
enabled
boolean

Indicates whether MFA is currently enabled.