Set Preferred MFA Method

Chooses which enabled channel is offered first at sign-in. It changes the order, never what is enabled — nothing is turned on or off here, and the account is exactly as protected afterwards.

On success the response has no body (204).

Failures:

• 400 — that channel is not enabled on the account.
• 404 — no such user.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

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",
  "secret": "<string>"
}
'

400

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id · string · obrigatório

User ID.

Exemplo:

"00000000-0000-0000-0000-000000000000"

Corpo

application/json

Which enabled channel to prefer.

mfaType · string · obrigatório

Exemplo:

"app"

secret · string

Resposta

204

No Content