Skip to content

TenantWithRole

Tenant with user’s role (for “my tenants” endpoint)

Property Type Description Inherited from
created_at string Creation timestamp Tenant.created_at
db_name? string | null Database name (null = uses main database, for backward compatibility) Tenant.db_name
deleted_at? string | null Soft delete timestamp Tenant.deleted_at
id string Unique identifier for the tenant Tenant.id
is_default boolean Whether this is the default tenant Tenant.is_default
metadata? Record<string, unknown> Arbitrary metadata Tenant.metadata
my_role "tenant_admin" Current user’s role in this tenant (always tenant_admin with database-per-tenant) -
name string Display name Tenant.name
slug string URL-friendly identifier (e.g., “acme-corp”) Tenant.slug
status TenantStatus Current status of the tenant Tenant.status
updated_at? string Last update timestamp Tenant.updated_at