Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
MFA API

Set Preferred MFA Method

Use this endpoint to set the preferred MFA method for a user. The selected method must already be enabled.

patch/v1/users/{id}/mfa/preferred

Path parameters

idstring required

The unique identifier of the user you want to retrieve.

Request body

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

The MFA type to set as preferred.

secretstring

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

Response

Preferred MFA method updated successfully.

preferredTypestring