GET/api/me/organization-mfa-requirementsAuthenticated

List my organizations that require MFA

The organizations the caller is a member of that require multi-factor authentication, and where the caller stands: compliant (they have MFA), within a grace period (enable MFA before it ends to stay a member), or past it (the membership is suspended and will be removed). Includes memberships suspended by an ended grace period, which other membership listings leave out.

operationId get_api_me_organization_mfa_requirementsAccount

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials
Who may call
Any authenticated user

Responses

application/json
PropertyTypeDescription
success*true
message*string
data*object
mfa_enabled*boolean

Whether the caller has a verified MFA factor

organizations*MyOrganizationMfaRequirement[]
organization_id*string

minLength: 4maxLength: 32pattern: ^[a-z][a-z0-9_-]+$

organization_name*string
grace_period_days*integer

Days members without MFA get to enable it before they are removed (1-90).

minimum: 1maximum: 90

required_since*number

Unix epoch milliseconds MFA became required

status*"compliant" | "pending" | "grace_period" | "expired"

compliant: the caller has MFA. grace_period: the caller must enable MFA before grace_period_ends_at to stay a member. expired: the grace period ended; the membership is suspended until MFA is enabled, and removed by the next enforcement run. pending: the caller has no MFA and no grace period was started yet.

grace_period_reason*"requirement_enabled" | "mfa_removed" | null | null

Why the grace period started: requirement_enabled (the organization started requiring MFA) or mfa_removed (the member lost their last MFA factor while a member).

grace_period_ends_at*number | null | null

Unix epoch milliseconds the caller's grace period ends; null when they have MFA or none was started

JSONExample
"success"true
"message""string"
"data"
"mfa_enabled"true
"organizations"

Example request

bashcurl
curl -X GET 'https://auth.schemavaults.com/api/me/organization-mfa-requirements' \
  -b 'refresh_token_<auth_server_app_id>=<value>'