Tenant Manager user interface reference

A guide to the Tenant Manager interface elements, including the tenant list columns, creation form fields, and their technical constraints.

Access and overview

The Tenant Manager console is the dedicated administration tool for service providers. You can access it at a URL derived from the baseDomainName parameter specified during installation.

Important: The decision to enable or disable multitenancy is permanent. Changing the enabled field from true to false (and vice-versa) after the initial installation is not supported. The configuration must be finalized before the first deployment.

The main screen displays a list of all tenants, with options to filter by type or status. Create tenant opens the provisioning form.

Tenant list columns

The tenant list displays key information for each customer instance, or Tenant.

Tenant name
The unique, technical name of the tenant, used as the hostname prefix.
Display name
The display name for the tenant, shown in the UI.
Status
The current status of the tenant (Active or Inactive). The status is managed via the actions ribbon above the list.
Tenant type
The selected tenant classification, such as Trial or Production.
Source
The source of the tenant creation (e.g., Tenant Manager).
Account name
The organization name associated with the tenant.
Creation time
The time the tenant instance was created.
Expired time
The time when the tenant expired.
Removed time
The time when the tenant was removed (if applicable).

Tenant creation and override fields

The following fields are configured when creating or editing a tenant.

Tenant name

A unique name to be used as the hostname prefix. The name is combined with the tenantDbPrefix defined in values.yaml to create the dedicated tenant database name. The total resulting string cannot exceed 63 characters.

If the default tenantDbPrefix is used, the Tenant name must be limited to 28 characters or fewer to avoid MongoDB database naming errors.

Expiration time

An optional expiration date and time. Leave this field blank to set no expiration, unless the selected Tenant type has a default expiration period (e.g., Trial).

License quantity

The number of licenses allocated to the tenant.

Custom max throughput

Specify a custom maximum number of tasks that can be processed per minute for this tenant on a workstation to override the Current max throughput value. Leave this field blank to use the current value.

Custom monthly task run limit

Specify a custom maximum number of tasks that can run per month for this tenant to override the Current monthly task run limit value. Leave this field blank to use the current value.

Custom monthly AI Agent calls limit

Specify a custom maximum number of AI Agent calls that can be made per month for this tenant to override the Current monthly AI Agent calls limit value. Leave this field blank to use the current value.

Daily task run limit

Specify the maximum number of tasks that can run per day for this tenant. Leave this field blank to use the current daily limit.

Daily AI Agent calls limit

Specify the maximum number of AI Agent calls that can be made per day for this tenant. Leave this field blank to use the current daily limit.

Tenant administrators

A required list of user IDs given administrative privileges for this tenant.

User domains

Authorized user domains for this tenant.

Region

The region where the tenant is hosted.

Database name

The name of the database associated with the tenant.

Marketplace ID

The Marketplace identifier associated with the tenant.

Tenant status actions

You manage a tenant operational status using the actions ribbon in the main list view. The primary states are Active, Inactive, and Removed.

  • Deactivating: Temporarily disables all operations within the tenant environment. The tenant state changes to INACTIVE.
  • Activating: Restores a suspended tenant, allowing users to resume operations. The tenant state changes to ACTIVE.
  • Removing: This action initiates the permanent purge of all tenant data. The tenant moves to the REMOVED state.

Tenant removal procedure

To permanently remove a tenant and purge all associated data, you must perform the administrative deletion. This can only be initiated if the tenant is INACTIVE.

The final confirmation of the purge requires a unique removal key. The service provider administrator performing the deletion must obtain this key from the tenant owner, who can find it on their own Settings page under the Tenant section in the UI.

For details on the state transitions and cleanup delays, see the related topic on the tenant lifecycle.