Saltar al contenido principal
POST
/
v1
/
users
/
{id}
/
mfa
/
setup
Iniciar la configuración de MFA
curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mfaType": "app"
}
'
{
  "secret": "JBSWY3DPEHPK3PXP",
  "url": "otpauth://totp/Lerian:johndoe?secret=JBSWY3DPEHPK3PXP&issuer=Lerian",
  "recoveryCodes": [
    "a1b2c3d4e5",
    "f6g7h8i9j0",
    "k1l2m3n4o5"
  ],
  "mfaType": "app",
  "enabled": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

​
Authorization
string
header
requerido

El token de autorización en formato 'Bearer '.

Parámetros de ruta

​
id
string
requerido

Identificador único del usuario que deseas consultar.

Cuerpo

application/json

Información necesaria para iniciar la configuración de MFA de un usuario.

​
mfaType
enum<string>
requerido

Tipo de MFA que se desea configurar.

Opciones disponibles:
app,
email,
sms

Respuesta

Configuración de MFA iniciada correctamente. Almacena el secreto y los códigos de recuperación antes de continuar con la verificación.

Resultado de la iniciación de la configuración de MFA, incluyendo el secreto y los códigos de recuperación.

​
secret
string

Secreto TOTP que el usuario o la aplicación debe almacenar de forma segura.

​
url
string

URL de OTP Auth para la generación de código QR (solo TOTP).

​
recoveryCodes
string[]

Códigos de recuperación de un solo uso que el usuario debe almacenar.

​
mfaType
enum<string>

Tipo de MFA que se configuró.

Opciones disponibles:
app,
email,
sms
​
enabled
boolean

Indica si MFA está habilitado actualmente.