Skip to main content

Get Private Labeling/Branding Settings

GET 
https://$CUSTOM-DOMAIN/admin/v1/policies/label

Returns the currently active private labeling/branding configured on the instance level. The settings will trigger if the organization has not overwritten the settings or if no specific organization is called on the login UI. Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console.

Responses​

default label policy

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 (string)
    primaryColor hex value for primary color (string)

    hex value for primary color

    isDefault defines if the organization's admin changed the policy (boolean)

    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 (boolean)

    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 (string)

    hex value for warn color

    backgroundColor hex value for background color (string)

    hex value for background color

    fontColor hex value for font color (string)

    hex value for font color

    primaryColorDark hex value for primary color dark theme (string)

    hex value for the primary color dark theme

    backgroundColorDark hex value for background color dark theme (string)

    hex value for background color dark theme

    warnColorDark hex value for warning color dark theme (string)

    hex value for warning color dark theme

    fontColorDark hex value for font color dark theme (string)

    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
    themeMode string

    Possible values: [THEME_MODE_UNSPECIFIED, THEME_MODE_AUTO, THEME_MODE_DARK, THEME_MODE_LIGHT]

    Default value: THEME_MODE_UNSPECIFIED

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/policies/label' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
ResponseClear

Click the Send API Request button above and see the response here!