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

Set Preferred MFA Method

cURL

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"
}
'

200

Example

{
  "preferredType": "app"
}

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

200

application/json

Preferred MFA method updated successfully.

preferredType · string