v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

Tenant

Update current tenant

Update the current user's tenant (tenant admin; some fields superadmin-only).

patch/tenants/current

Query parameters

cookie_namestring nullable

tenant_idinteger

Request body

namestring nullable

Internal name of the tenant.

domainstring nullable

Primary email/web domain associated with the tenant.

parent_tenant_idinteger nullable

ID of the parent tenant. Changing requires superadmin.

subtenants_enabledboolean nullable

Whether this tenant may create child tenants. Changing requires superadmin.

timezonestring nullable

Default IANA timezone for the tenant.

localestring nullable

Default locale for the tenant.

tarif_idinteger nullable

ID of the tariff to assign. Changing requires superadmin.

tarif_expires_atstring date-time nullable

UTC timestamp when the assigned tariff expires. Changing requires superadmin.

max_usersinteger nullable

Maximum number of users allowed in the tenant.

max_projectsinteger nullable

Maximum number of projects allowed in the tenant.

licensesinteger nullable

Number of seats/licenses. Changing requires superadmin.

display_namestring nullable

Human-friendly display name shown in the UI.

mottostring nullable

Short tagline shown in the tenant's UI.

logo_urlstring nullable

URL of the tenant's primary logo.

square_logo_urlstring nullable

URL of the tenant's square logo variant.

favicon_urlstring nullable

URL of the tenant's favicon.

chat_square_logo_urlstring nullable

URL of the square logo shown in the chat UI.

primary_colorstring nullable

Primary brand color (hex).

secondary_colorstring nullable

Secondary brand color (hex).

themestring nullable

Name of the UI theme to apply.

storage_limit_gbinteger nullable

Storage limit for the tenant, in gigabytes.

api_rate_limitinteger nullable

API request rate limit for the tenant.

upstream_tenant_idstring nullable

UUID of the upstream identity-provider tenant. Changing requires superadmin.

upstream_oidc_issuerstring nullable

OIDC issuer URL of the upstream identity provider. Changing requires superadmin.

Example request

{
  "name": "Acme Corp",
  "domain": "acme.com",
  "parent_tenant_id": 1,
  "timezone": "Europe/Berlin",
  "locale": "en-US",
  "tarif_id": 2,
  "tarif_expires_at": "2026-12-31T23:59:59Z",
  "max_users": 100,
  "max_projects": 50,
  "licenses": 100,
  "display_name": "Acme Corporation",
  "motto": "Building the future.",
  "logo_url": "https://cdn.example.com/acme/logo.png",
  "square_logo_url": "https://cdn.example.com/acme/logo-square.png",
  "favicon_url": "https://cdn.example.com/acme/favicon.ico",
  "chat_square_logo_url": "https://cdn.example.com/acme/chat-logo.png",
  "primary_color": "#1A2B3C",
  "secondary_color": "#4D5E6F",
  "theme": "light",
  "storage_limit_gb": 100,
  "api_rate_limit": 1000,
  "upstream_tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "upstream_oidc_issuer": "https://login.example.com/"
}

Response

Successful Response

idinteger required

Unique identifier of the tenant.

created_atstring date-time required

UTC timestamp when the tenant was created.

creator_user_idinteger nullable

ID of the user who created the tenant, if known.

namestring required

Internal name of the tenant.

slugstring required

URL-safe unique identifier for the tenant.

domainstring nullable

Primary email/web domain associated with the tenant.

parent_tenant_idinteger nullable

ID of the parent tenant, when this is a child tenant.

subtenants_enabledboolean required

Whether this tenant may create child tenants.

timezonestring required

Default IANA timezone for the tenant.

localestring required

Default locale for the tenant.

tarif_idinteger nullable

ID of the tariff currently assigned to the tenant.

max_usersinteger nullable

Maximum number of users allowed in the tenant.

max_projectsinteger nullable

Maximum number of projects allowed in the tenant.

licensesinteger nullable

Number of seats/licenses for the tenant.

display_namestring nullable

Human-friendly display name shown in the UI.

mottostring nullable

Short tagline shown in the tenant's UI.

logo_urlstring nullable

URL of the tenant's primary logo.

square_logo_urlstring nullable

URL of the tenant's square logo variant.

favicon_urlstring nullable

URL of the tenant's favicon.

chat_square_logo_urlstring nullable

URL of the square logo shown in the chat UI.

primary_colorstring nullable

Primary brand color (hex).

secondary_colorstring nullable

Secondary brand color (hex).

themestring nullable

Name of the UI theme applied.

storage_limit_gbinteger nullable

Storage limit for the tenant, in gigabytes.

api_rate_limitinteger nullable

API request rate limit for the tenant.

statestring nullable

Lifecycle state of the tenant.

upstream_tenant_idstring nullable

UUID of the upstream identity-provider tenant.

upstream_oidc_issuerstring nullable

OIDC issuer URL of the upstream identity provider.

Example response

{
  "id": 1,
  "created_at": "2026-01-15T08:30:00Z",
  "creator_user_id": 42,
  "name": "Acme Corp",
  "slug": "acme-corp",
  "domain": "acme.com",
  "parent_tenant_id": 1,
  "timezone": "Europe/Berlin",
  "locale": "en-US",
  "tarif_id": 2,
  "max_users": 100,
  "max_projects": 50,
  "licenses": 100,
  "display_name": "Acme Corporation",
  "motto": "Building the future.",
  "logo_url": "https://cdn.example.com/acme/logo.png",
  "square_logo_url": "https://cdn.example.com/acme/logo-square.png",
  "favicon_url": "https://cdn.example.com/acme/favicon.ico",
  "chat_square_logo_url": "https://cdn.example.com/acme/chat-logo.png",
  "primary_color": "#1A2B3C",
  "secondary_color": "#4D5E6F",
  "theme": "light",
  "storage_limit_gb": 100,
  "api_rate_limit": 1000,
  "state": "active",
  "upstream_tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "upstream_oidc_issuer": "https://login.example.com/"
}