Skip to main content
Tenants represent the people, teams, organizations, apps, or agents that use integrations in your workspace. Every tenant has their own set of connections, element customizations, and activity logs. Membrane creates tenants automatically when a new ID appears in an Access Token. You can also create and manage them using the API endpoints below. For a conceptual overview of how tenants work, data visibility, and recommended usage patterns, see Tenants in the docs.

​
Tenant Structure

  • id — Unique identifier of the tenant
  • internalId — Your system’s identifier for this tenant (unique per workspace)
  • name — Display name shown in the Membrane Console
  • fields — Arbitrary metadata object for storing tenant-specific data (e.g., API keys, preferences, plan tier)
  • credentials (secret) — Encrypted credentials associated with the tenant
  • createdAt — Timestamp when the tenant was created
  • aiCreditsRolling30DayLimit — Per-tenant AI credit limit for a rolling 30-day window (null for unlimited)

​
Tenant Fields

Each tenant has fields that contain any information you need to use in your integration logic. For example, you can store a user’s API Token in fields.apiToken and use it to make requests to your API from within integrations.

​
Defining the Field Schema

You can define the schema for tenant fields in the “Tenant Field Schemas” section of the Settings > General page. Important: Tenant fields will not appear in the Console UI unless you define their schema first. While you can still set field values via authentication tokens or the API, they will only become visible in the Console after you:
  1. Navigate to Settings > General
  2. Define the field schema in the “Tenant Field Schemas” section
  3. Specify the field names, types, and other properties

​
Setting Field Values

You can set tenant fields in two ways:
  1. By adding a fields claim to the Authentication Token. Whenever Membrane sees a new set of fields in the token, it saves them to be used going forward.
  2. By updating tenants using the PATCH or PUT endpoints below.

​
Connections

Each tenant can have multiple connections to external applications. See Connections for details.

​
Tenant-level Customizations

Tenants can have their own customizations of workspace-level elements (actions, flows, data sources, field mappings). This allows tenant-specific configuration while inheriting the workspace-level template. To create a tenant-level customization:
  • Go to the Tenants page
  • Select the tenant
  • Navigate to the element type (e.g., Flows) inside the tenant’s page
  • Create or customize an element