Skip to main content
Staff only

Finding and creating a tenant

Find a tenant in the staff console, create one, and see what each part of a tenant’s page is for.

What you'll need
  • The Tenants module visible in your left-hand navigation.
  • A staff sign-in — a separate address and session from the tenant app.

If Tenants isn't in your navigation, your role doesn't have visibility for it — ask a workspace administrator, or see Permissions and module visibility.

The tenant list

Open Tenants from the app menu at the header’s top-left, headed Available Apps, or an Overview card.

ColumnWhat it holds
TENANT NAMEThe name; opens the tenant.
SLUGThe subdomain.
STATUSActive, Suspended, Offboarding or Deleted.
CREATEDCreation date, or .
ACTIONSView always; Delete and Deactivate Tenant while Active; Activate Tenant and Delete while Suspended.

Type in Search by name to match the name only, narrow with Filter by status — headed Show tenants, offering All plus those four statuses — and order with Sort By (Latest) by Name, Status or Created At. It arrives sorted by name ascending, whatever the button says. Pages hold 10 rows until you change Rows per page; an empty list reads No tenants found.

Steps

  1. Select Add Tenant. A drawer titled Add New Tenant opens.

  2. Enter Tenant Name, Subdomain and Primary Contact Email, then pick PlanStarter (pre-selected), Growth or Enterprise. The subdomain is permanent.

  3. Under Invite Admin (Optional), add an Admin Email; Admin Display Name unlocks then, and is required once it does.

  4. Select Add Tenant; it reads Saving… while saving, and is disabled until valid.

What success looks like

  • Tenant added successfully! appears — with Invitation sent successfully! if you supplied an admin — and the drawer closes and clears.
  • Per the drawer’s note, the tenant record, its entitlements and its system roles exist.

Inside a tenant

Selecting the name, or View, opens the tenant under a Settings sidebar of three sections.

  • Tenant Details — the read-only record, plus Edit Basic Details; a deactivated tenant also shows Suspension Reason (suspending or reactivating).
  • Entitlements — what this tenant may use (managing entitlements).
  • Gateways — its one federated sign-in connection (gateways).

If something goes wrong

SymptomLikely causeWhat to do
Add Tenant stays greyed out.A required field is invalid, or an Admin Email with no Admin Display Name.Complete the required fields, or clear the admin email.
Tenant name can only contain letters, numbers, spaces and & . , ' - characters.A rejected character.Remove it; names also cap at 100 characters.
Only View on a row, or only Close once open.It is Offboarding or Deleted, so read-only.Nothing to change.

Next

Steps verified against elie-staff-ui 0.1.0 on . Something wrong with this page?