Skip to main content

Get Private Labeling/Branding Settings​

Returns the currently active private labeling/branding configured on the organization. The settings will trigger if the organization has been identified (organization scope, user). Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console.

Header Parameters
  • x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Responses

A successful response.

Schema
  • policy object
  • 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

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: 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

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

    hex value for primary color

  • isDefault defines if the organization's admin changed the policy

    defines if the organization's admin changed the policy

  • 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

  • warnColor hex value for secondary color

    hex value for warn color

  • backgroundColor hex value for background color

    hex value for background color

  • fontColor hex value for font color

    hex value for font color

  • primaryColorDark hex value for primary color dark theme

    hex value for the primary color dark theme

  • backgroundColorDark hex value for background color dark theme

    hex value for background color dark theme

  • warnColorDark hex value for warning color dark theme

    hex value for warning color dark theme

  • fontColorDark hex value for font color dark theme

    hex value for font color dark theme

  • disableWatermark boolean
  • logoUrl string

    hex value for font color dark theme

  • iconUrl string

    hex value for font color dark theme

  • logoUrlDark string

    hex value for font color dark theme

  • iconUrlDark string

    hex value for font color dark theme

  • fontUrl string
  • isDefault deprecated: is_default is also defined in zitadel.policy.v1.LabelPolicy
Loading...