Tenant — How it works
Overview
The tenant engine defines the platform's top-level multi-tenancy boundary. A tenant is an
isolated customer/organization; every business row across the platform carries a tenant_id, and
tenant-scoped uniqueness and access decisions hang off it. The engine also holds a tenant's branding,
configuration, and subscription.
Data model & ownership
| Table | Purpose |
|---|---|
tenant | The isolation boundary; unique tenant code/name. |
tenant_branding | Per-tenant look & feel. |
tenant_configuration | Per-tenant settings. |
tenant_subscription | Subscription/plan state. |
Key rules & invariants
- Tenant code is unique; a tenant is the scoping key other engines validate against (e.g. demographic search requires a valid tenant).
- Cross-tenant data never mixes — tenant-scoped rows filter by
tenant_id.
API
See the API Reference. Endpoint groups under /api/v1/tenant: tenants, branding,
configuration, subscription.
Configuration & feature flags
None.
Related features
- Nearly every engine references
tenant_id; Facility, Access control, and Platform configuration scope by tenant.