Tenant Management

Tenants provide a secondary layer of isolation within a Company. They are useful for segmenting configurations between different teams or products.

Isolation & Security

Tenants provide strong isolation for your API consumers and keys. A consumer assigned to one tenant cannot access endpoints belonging to another tenant, unless explicitly shared through a common Catalog.

UI Usage Guide

Follow these steps to create and manage tenants.

Step 1: Create a Tenant

Navigate to the Tenants page from the sidebar menu.

  1. Click the "Create" (or "+") button.
  2. Fill in Tenant Name, Slug, and Description.
  3. Configure Rate Limit and Timeout as needed.
  4. Click "Save" to create the tenant.
  5. A success message confirms the tenant was created.
Tenant creation form filled

Step 2: Edit an Existing Tenant

  1. Navigate to Tenants from the sidebar menu.
  2. Click the edit icon on the tenant row.
  3. Modify the Tenant Name or other fields.
  4. Click "Save" to apply changes.
Edit tenant dialog