Menu AuthGuardHelp centre
Portuguêsauthguard.pt

Developers · API

/v1/meta: features served and organization state

  • 1 min read
  • SaaS · Self-hosted

GET /v1/meta is public and identical for every request to the same address. The console uses it to decide which views to show; an integration can use it to learn what the service offers.

The features field

It lists the optional features the service serves (their routes are mounted and backed by storage):

ValueFeature
helpdeskHelpdesk authenticator reset
privacyGDPR tools
emailEmail sending (verification and recovery)
intentsThird-party requests
oidcOpenID Connect provider
ssoSingle sign-on
endpointsWindows sign-in
radiusClassic RADIUS and RadSec
edgeEdge appliances

A missing feature means its routes answer 503 or do not exist, and the console hides the item.

Other useful fields

FieldMeaning
realmKindplatform, reseller or tenant
realmStatusprovisioning, active, suspended, pending_deletion
activationPendingThe first administrator has not finished activation
deviceApproverAvailable, deviceWakeAvailableApprover phones and notification alerts are configured
deviceSignInAvailablePhone-only sign-in is served
licenseStatenone, active, warning, grace, expired
whiteLabel, brandingRevision, logoWhite label and branding

With ?realm=<slug>, the answer also says whether that organization offers phone-only sign-in.

Error codes in this article

Article referencedev-metaquote it to support to identify this article. Checked against the product at commit 5f6607a8.