Read a user's MFA settings

GET

/mfa/users/{user}/settings

const url = 'https://work.optidata.cloud/api/mfa/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://work.optidata.cloud/api/mfa/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/settings \
  --header 'Authorization: Bearer <token>'

Multi-factor settings of the user, created with their defaults on first read.

Authorizations

bearerAuth

Parameters

Path Parameters

user

required

string format: uuid

UUID of the user.

Responses

200

The user’s MFA settings.

application/json

object

integer format: int64

user_id

integer format: int64

is_2fa_enabled

Whether a second factor is required at login.

boolean

created_at

string format: date-time

updated_at

string format: date-time

key

additional properties

any

Examples

settings

{
  "id": 42,
  "user_id": 15,
  "is_2fa_enabled": true,
  "created_at": "2026-02-01T10:00:00.000000Z",
  "updated_at": "2026-08-01T10:00:00.000000Z"
}

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

The resource does not exist, or does not belong to the given drive.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

missing

{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

429

Rate limit exceeded. Retry after the window resets.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}