ZITADEL Docs
APIsCore ResourcesV2Settings

GetBrandingSettings

Get Branding Settings

Get the current active branding settings for the requested context. This can be the instance or an organization. In case of an organization, the returned settings will fall back to the instance settings if not explicitly set on the organization.

Required permissions:

  • policy.read
GET
/v2/settings/branding

Query Parameters

ctx.orgId?string
ctx.instance?boolean

Response Body

application/json

application/json

curl -X GET "https://loading/v2/settings/branding"
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "settings": {
    "lightTheme": {
      "primaryColor": "string",
      "backgroundColor": "string",
      "warnColor": "string",
      "fontColor": "string",
      "logoUrl": "string",
      "iconUrl": "string"
    },
    "darkTheme": {
      "primaryColor": "string",
      "backgroundColor": "string",
      "warnColor": "string",
      "fontColor": "string",
      "logoUrl": "string",
      "iconUrl": "string"
    },
    "fontUrl": "string",
    "hideLoginNameSuffix": true,
    "disableWatermark": true,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
    "themeMode": "THEME_MODE_UNSPECIFIED"
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?