Obtener el estado de MFA

Utiliza este endpoint para obtener la configuración actual y el estado de MFA de un usuario.

GET /v1/users/{id}/mfa

Obtener el estado de MFA

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "enabled": true,
  "preferredType": "app",
  "methods": [
    "app"
  ],
  "totpEnabled": true,
  "emailEnabled": false,
  "smsEnabled": false
}

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.

Respuesta

200

application/json

Estado y configuración de MFA del usuario.

Configuración y estado actuales de MFA de un usuario.

enabled · boolean

Indica si MFA está habilitado para el usuario.

preferredType · enum<string>

Método de MFA preferido del usuario.

Opciones disponibles: app, email, sms

methods · string[]

Lista de métodos de MFA habilitados actualmente para el usuario.

totpEnabled · boolean

Indica si MFA basado en TOTP de aplicación está habilitado.

emailEnabled · boolean

Indica si MFA basado en correo electrónico está habilitado.

smsEnabled · boolean

Indica si MFA basado en SMS está habilitado.