v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
MFA API

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

Path parameters

idstring required

The unique identifier of the user you want to retrieve.

Request body

secretstring

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

recoveryCodestring required

A valid recovery code obtained during MFA setup.

mfaType'app' | 'email' | 'sms' required

The type of MFA to enable.

Response

MFA enabled successfully for the user.

enabledboolean