Skip to main content

Get the current active branding settings​

Return the current active branding settings for the requested context

Query Parameters
  • ctx.orgId string
  • ctx.instance boolean
Responses

OK

Schema
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • resourceOwner resource_owner is the organization or instance_id an object belongs to
  • settings object
  • lightTheme object
  • primaryColor hex value for primary color

    hex value for primary color

  • backgroundColor hex value for background color

    hex value for background color

  • warnColor hex value for warning color

    hex value for warn color

  • fontColor hex value for font color

    hex value for font color

  • logoUrl url where the logo is served

    url to the logo

  • iconUrl url where the icon is served

    url to the icon

  • darkTheme object
  • primaryColor hex value for primary color

    hex value for primary color

  • backgroundColor hex value for background color

    hex value for background color

  • warnColor hex value for warning color

    hex value for warn color

  • fontColor hex value for font color

    hex value for font color

  • logoUrl url where the logo is served

    url to the logo

  • iconUrl url where the icon is served

    url to the icon

  • fontUrl string

    url to the font used

  • hideLoginNameSuffix hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is set

    hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set

  • disableWatermark boolean

    boolean to disable the watermark

  • resourceOwnerType resource_owner_type returns if the setting is managed on the organization or on the instance

    Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

    Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

    resource_owner_type returns if the setting is managed on the organization or on the instance

Loading...