TenantBranding

Branding and visual identity configuration for a tenant workspace, enabling white-labeling and custom branding in multi-tenant SaaS platforms. This entity defines the visual appearance of the tenant's workspace including logos, color schemes, custom domains, favicons, and theme settings. It supports complete brand customization where each tenant can have their own visual identity, creating a seamless branded experience for their users. The entity enables use cases such as white-label SaaS products, partner portals with custom branding, client-facing applications with customer logos, and multi-brand platforms. It serves as the visual identity layer for tenant customization, working in conjunction with TenantSettings for complete workspace personalization.

11 properties
Schema

Properties

PropertyTypeModeDescriptionRequired
tenantTenant
stored

Reference to the Tenant this branding applies to

Required
logoUrlstring
stored

URL to the tenant's primary logo

Example: "https://cdn.example.com/tenants/acme/logo.png"

Optional
logoSmallUrlstring
stored

URL to a smaller version of the logo (for navigation bars, mobile)

Example: "https://cdn.example.com/tenants/acme/logo-small.png"

Optional
faviconUrlstring
stored

URL to the tenant's favicon

Example: "https://cdn.example.com/tenants/acme/favicon.ico"

Optional
primaryColorstring
stored

Primary brand color (hex code)

Example: "#3B82F6"

Optional
secondaryColorstring
stored

Secondary brand color (hex code)

Example: "#10B981"

Optional
accentColorstring
stored

Accent color for highlights and CTAs (hex code)

Example: "#F59E0B"

Optional
customDomainstring
stored

Custom domain for this tenant's workspace (e.g., portal.acme.com)

Example: "portal.acme.com"

Optional
customCSSstring
stored

Custom CSS for advanced branding customization

Optional
themestring
stored

Default theme preference for the tenant

Values: light, dark, auto

Example: "light"

Optional
metadatajson
stored

Additional branding metadata (fonts, custom assets, etc.)

Optional

Examples

Example 1

{
  "@type": "TenantBranding",
  "tenant": {
    "@type": "Tenant",
    "slug": "acme-corp",
    "name": "ACME Corporation"
  },
  "logoUrl": "https://cdn.example.com/acme/logo.png",
  "logoSmallUrl": "https://cdn.example.com/acme/logo-small.png",
  "faviconUrl": "https://cdn.example.com/acme/favicon.ico",
  "primaryColor": "#3B82F6",
  "secondaryColor": "#10B981",
  "accentColor": "#F59E0B",
  "customDomain": "portal.acme.com",
  "theme": "light"
}

Example 2

{
  "@type": "TenantBranding",
  "tenant": {
    "@type": "Tenant",
    "slug": "techstart",
    "name": "TechStart Inc"
  },
  "logoUrl": "https://cdn.example.com/techstart/logo.png",
  "primaryColor": "#8B5CF6",
  "theme": "dark"
}