Enable MFA

Use this endpoint to enable MFA for a user after the passcode has been verified. A valid recovery code is required to confirm the action.

POST /v1/users/{id}/mfa/enable

Enable MFA

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa/enable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recoveryCode": "a1b2c3d4e5",
  "mfaType": "app",
  "secret": "JBSWY3DPEHPK3PXP"
}
'

200

Example

{
  "enabled": true
}

Authorizations

Authorization · string · header · required

The authorization token in the 'Bearer ' format.

Path Parameters

id · string · required

The unique identifier of the user you want to retrieve.

Body

application/json

Information required to enable MFA after passcode verification.

recoveryCode · string · required

A valid recovery code obtained during MFA setup.

mfaType · enum<string> · required

The type of MFA to enable.

Available options: app, email, sms

secret · string

The TOTP secret (required for app-based MFA).

Response

200

application/json

MFA enabled successfully for the user.

enabled · boolean