Tenants
A tenant is your company or customer entity on the installation: a group of people and agents that work in Istari together, managed by its own Tenant Administrators. Each person and agent belongs to at most one tenant; see Membership.
Platform Administrators manage tenants from the Tenants page of the Platform Admin Console, at /console/tenants. Tenant Administrators manage their own tenant's people from the Admin Panel's Users page instead; see User Management.
Each tenant has:
- a display name, which you can change;
- a slug, a short identifier chosen when the tenant is created, which cannot change afterwards. IT uses it to link the tenant to your sign-in provider;
- an optional description, which you can change.
The tenants list
The tabs above the table filter by status: All, Active (the default) and Suspended, each with a count.
- A grey Default chip marks the default tenant.
- The Members count is the number of people in the tenant; agents are not counted. Clicking the count opens the tenant's page, whose Members section lists those people.
Each row ends with an Edit pencil, which opens the tenant's page, and a ⋮ menu:
- Set as default, disabled on the default tenant's own row with "This is the default tenant."
- Suspend, or Reactivate for a suspended tenant.
Create a tenant
Check the tenants list first, because the tenant may already exist. When the platform is installed or upgraded, it can create a tenant for each organization in your sign-in provider that it was set up to read. Those tenants are ready for sign-in.
- Click New tenant.
- Enter a Display name.
- Enter a Slug: lowercase letters and numbers, with single hyphens between them, up to 63 characters. It cannot change later.
- Optionally enter a Description.
- Click Create tenant. If the slug is taken, the dialog stays open with "A tenant with that slug already exists." under the slug.
- Ask your IT administrator to link the tenant to an organization in your sign-in provider, and give them the slug (Copy slug on the tenant's page). IT follows Map the organization to a tenant.
Until IT has linked the tenant, nobody can sign in to it, and adding a person to it is refused with a message that the tenant maps to no organization.
Edit a tenant
- Open the tenant's page from its name or its Edit pencil.
- To rename it, click the pencil beside the name, type the new name, and press Enter. Escape cancels.
- To change the description, edit the Description field and click Save. Discard drops your changes.
The slug shows below the description as a read-only field with a Copy slug button.
Make a tenant the default
The default tenant is the one a person joins when no other tenant is named for them. For example, the Add user dialog in the Platform Admin Console starts on it. At most one tenant is the default, and it must be active.
Choose Set as default in the tenant's row menu. The Default chip moves at once. A suspended tenant cannot be the default; its Set as default is disabled with "Reactivate this tenant before making it the default."
If Set as default and the Default chip are missing, your installation has hidden them. Your IT administrator controls this with the web app setting VITE_DEFAULT_TENANT_CONTROLS_ENABLED; false hides them.
Suspend a tenant
Suspending a tenant stops its people and agents from signing in. Only a Platform Administrator can suspend a tenant.
If the tenant is your own, suspending it suspends you too, and you lose access to the platform.
- Choose Suspend in the tenant's row menu, or click the Suspend tenant icon button beside the status in the header of its page.
- Read the consequences the dialog lists:
- Everyone in the tenant, people and agents, is suspended and loses access to the platform.
- By default, every membership and role grant in the tenant is revoked. So is every other role those people and agents hold, including the Platform Administrator role.
- Reactivating the tenant restores the tenant only; see Reactivate a tenant.
- Type the tenant's name, exactly as shown, to enable Suspend.
- Click Suspend.
Your installation may instead be set to keep memberships and roles when a tenant is suspended. Ask your IT administrator which your installation does.
If the default tenant is suspended, the oldest other active tenant becomes the default. Reactivating the suspended tenant does not make it the default again.
The dialog stays open with the reason when the suspension is refused:
| Situation | Message |
|---|---|
| It is the only active tenant | "Cannot suspend the only active tenant. Activate another tenant first." |
| It would leave the installation with no active Platform Administrator | "The installation keeps at least one active platform administrator." |
Reactivate a tenant
Choose Reactivate in the tenant's row menu, or click the Reactivate tenant icon button in the header of its page. There is no confirmation.
Reactivating restores the tenant only. Its people and agents stay suspended until an administrator reactivates them. To bring each person back:
- If they hold no membership (Reactivate is disabled for them), grant one: add them with Add user in the tenant's Members section, or use Grant membership on their details page.
- Reactivate the person from Users; see Reactivate a person.
- If their administrator roles were revoked, grant them again; see Grant an administrator role.
Manage a tenant's members
A tenant's page has a Members section below its details, headed Members (N). It is the Platform Admin Console's users list fixed to this tenant: the same search, status tabs, Add user, Add from CSV and row actions, with no Tenant dropdown or column. See User Management.