Tenant lifecycle

The tenant lifecycle defines the sequence of operational states a tenant moves through, from creation to permanent removal, and the events that trigger these transitions.

Each state determines a tenant operational status and permitted actions. A state machine governs the lifecycle, with administrative actions or automated system processes triggering transitions.

Tenant types

Tenants are categorized by type. The type influences the lifecycle, particularly regarding expiration. Available types include TRIAL, QA, DEV, PROD, and INTERNAL.

The primary functional distinction is between TRIAL tenants and all other types. A TRIAL tenant has a default expiration period, after which it automatically moves to an inactive state. Other tenant types do not expire automatically unless explicitly configured.

Tenant states

A tenant exists in one of three states. A service provider administrator manages these states using the Tenant Manager.

ACTIVE
The standard operational state. The tenant is fully functional, and users can perform operations.
INACTIVE
A suspended state where tenant operations are paused. A tenant becomes inactive if an administrator manually deactivates it or if it reaches its expiration date. In this state, users can access the UI but cannot perform operations. A tenant returns to the ACTIVE state automatically upon license renewal or manually by a service administrator.
REMOVED
In this state, the system permanently purges tenant data. A tenant moves to the REMOVED state automatically after it remains inactive for a specific configured period. Alternatively, a tenant owner can request immediate service termination by providing a unique removal key. The owner must obtain this key from the Tenant section of the system settings page in the tenant UI. Once removed, no further administrative actions are possible.
State transitions

Specific events trigger moves between states. A new tenant starts in the ACTIVE state. An administrator can manually transition a tenant between ACTIVE and INACTIVE.

Expiration automatically transitions an ACTIVE tenant to INACTIVE. An administrator can manually reactivate or delete an inactive tenant. The system can also automatically transition an inactive tenant to REMOVED after a pre-defined cleanup delay.