dashboard.trueparser.com, while the backend can be deployed separately, for example at admin-api.trueparser.com.
This page introduces the core concepts developers need before using the other docs.
Main Concepts
Tenant
A tenant represents an organization boundary.- top-level container for resources, billing, and team members
- tenant status affects whether tenant apps can issue tokens
App
Each tenant can create multiple apps.- each app gets its own
client_idandclient_secret - each app is tied to a license region at creation time
- each app stores region, database, plan, and allowed-domain metadata
- each app can be enabled or disabled independently
Plan
A plan defines the limits that may be added to the app’s token.- current plan fields include unit-based quotas and
maxApiRequestsPerMinute - plans are assigned per app
- a missing plan does not block token issuance
- a retired assigned plan does block token issuance
License Region
License regions are host-managed records used during app creation.- app creation validates the region code
- the selected region must have an active region database
- the resolved
DbCodeis stamped onto the app
Security Model
Apps can store up to three allowed domains.- domains are normalized before storage
- wildcards are rejected
localhostwith an optional port is allowed- when present, allowed domains are added to the issued access token as claims
Token Issuance Model
Tenant apps use OAuth 2.0client_credentials against the token endpoint.
- the token endpoint is
/connect/token - access token lifetime is configured to 15 minutes
- the token includes tenant, app, region, and database claims
- if the app has a usable plan, the token also includes
limits(measured in Document Units)
tenantidappIdlicenseRegionCodedbCodeallowed_domain_1,allowed_domain_2,allowed_domain_3limitswhen a usable plan is assigned