Skip to main content
PATCH
/
v1
/
users
/
{id}
/
mfa
/
preferred
Set Preferred MFA Method
curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa/preferred \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mfaType": "app"
}
'
{
  "preferredType": "app"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

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 set the preferred MFA method.

​
mfaType
enum<string>
required

The MFA type to set as preferred.

Available options:
app,
email,
sms
​
secret
string

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

Response

Preferred MFA method updated successfully.

​
preferredType
string