Pular para o conteúdo principal
POST
/
v1
/
users
/
{id}
/
mfa
/
setup
Iniciar Configuração 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
}

Autorizações

​
Authorization
string
header
obrigatório

O token de autorização no formato 'Bearer '.

Parâmetros de caminho

​
id
string
obrigatório

O identificador único do usuário que você deseja recuperar.

Corpo

application/json

Informações necessárias para iniciar a configuração do MFA de um usuário.

​
mfaType
enum<string>
obrigatório

O tipo de MFA a ser configurado.

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

Resposta

Configuração de MFA iniciada com sucesso. Armazene o segredo e os códigos de recuperação antes de prosseguir para a verificação.

O resultado da iniciação da configuração do MFA, incluindo o segredo e os códigos de recuperação.

​
secret
string

Segredo TOTP a ser armazenado de forma segura pelo usuário ou aplicativo.

​
url
string

URL OTP Auth para geração de QR Code (somente TOTP).

​
recoveryCodes
string[]

Códigos de recuperação de uso único a serem armazenados pelo usuário.

​
mfaType
enum<string>

O tipo de MFA que foi configurado.

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

Indica se o MFA está atualmente habilitado.