Skip to content

Tenants (TenancyEngine) ​

Cross-application directory of customer organizations on your SaaS products. Filter by application, status, or release channel, or open an application workspace for product-scoped tenant management.

Console: TenancyEngine console → Tenants (/tenants)

Requires Tenants read to view; Tenants write to create or edit.

What the table shows ​

Each row is a tenant (customer org) on a registered application: name, slug, status, release channel, and links to manage users, entitlements, and usage.

Use filters to narrow by application, status, channel, or search by name/slug.

Add a tenant ​

  1. Click Add tenant.
  2. Pick the application the tenant belongs to.
  3. Enter name and slug (slug is permanent).
  4. Choose a release channel (Stable, Beta, or Preview) for feature rollout.
  5. Save — the tenant appears in the directory and in the application workspace.

Plan limits may block new tenants when the organization has reached its platform.tenants.max cap.

Edit tenant modal ​

Click Edit on a row to open the modal. Four tabs organize tenant administration:

Details ​

  • Slug and created-in environment are read-only after creation.
  • Update organization name, status (Active, Suspended, Archived), and release channel (Stable, Beta, Preview).
  • Click Save changes in the modal footer — other tabs save independently where noted.

Environment access ​

Control which deployment environments (Development, Staging, Production) the tenant may sign into.

  • Toggle checkboxes to assign or revoke access per environment.
  • When assignments exist, login is limited to active environments.
  • With no assignments, access follows the tenant's created-in environment.

Entitlements ​

Assign the tenant's active offering (L1 plan) from the application's product catalog.

  • The offering drives runtime entitlements and feature limits for that tenant.
  • Pick an offering from the dropdown and click Assign plan — changes apply to the tenant's contract.
  • See Tenant entitlements for L0 vs L1 scope and assignment detail.

Usage ​

View and adjust metered usage against entitlement limits (per environment).

  • Meters show current value, limit, reset period, and progress bars.
  • Operators with usage permissions can adjust (delta) or set absolute values for support scenarios.

Row-level Users actions (outside the modal) manage tenant end-user accounts and impersonation.

Delete ​

Deleting a tenant requires typing the tenant slug to confirm — this is irreversible.

Support impersonation ​

Platform staff with impersonation permissions can start tenant-user impersonation from the Users tab on a tenant row (L1 app support). A banner appears while a session is active.

TenancyEngine platform documentation