Skip to main content
GET
/
v1
/
users
/
{id}
/
mfa
Get MFA Status
curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa \
  --header 'Authorization: Bearer <token>'
{
  "enabled": true,
  "preferredType": "app",
  "methods": [
    "app"
  ],
  "totpEnabled": true,
  "emailEnabled": false,
  "smsEnabled": false
}

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.

Response

MFA status and configuration for the user.

The current MFA configuration and status for a user.

​
enabled
boolean

Indicates whether MFA is enabled for the user.

​
preferredType
enum<string>

The user's preferred MFA method.

Available options:
app,
email,
sms
​
methods
string[]

List of MFA methods currently enabled for the user.

​
totpEnabled
boolean

Indicates whether app-based TOTP MFA is enabled.

​
emailEnabled
boolean

Indicates whether email-based MFA is enabled.

​
smsEnabled
boolean

Indicates whether SMS-based MFA is enabled.