Skip to main content

Update Labeling/Branding Settings

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

Update the preview private labeling/branding configured on the instance level. It affects all organizations, that don't overwrite the settings. The preview is used to show you how it will look like, make sure to activate it as soon as you are happy with the configuration. Define what colors, fonts, and logo should be used for the Login/Register UI, E-Mails and Console.

Request​

Body

required

    primaryColor string

    Possible values: <= 50 characters

    represents a color scheme

    hideLoginNameSuffix boolean

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

    warnColor string

    Possible values: <= 50 characters

    hex value for warn color

    backgroundColor string

    Possible values: <= 50 characters

    hex value for background color

    fontColor string

    Possible values: <= 50 characters

    hex value for font color

    primaryColorDark string

    Possible values: <= 50 characters

    hex value for the primary color dark theme

    backgroundColorDark string

    Possible values: <= 50 characters

    hex value for background color dark theme

    warnColorDark string

    Possible values: <= 50 characters

    hex value for warning color dark theme

    fontColorDark string

    Possible values: <= 50 characters

    hex value for font color dark theme

    disableWatermark boolean
    themeMode string

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

    Default value: THEME_MODE_UNSPECIFIED

    setting if there should be a restriction on which themes are available

Responses​

default label policy updated

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

    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)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/policies/label' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "primaryColor": "#353535",
  "hideLoginNameSuffix": true,
  "warnColor": "#CD3D56",
  "backgroundColor": "#FAFAFA",
  "fontColor": "#000000",
  "primaryColorDark": "#BBBAFA",
  "backgroundColorDark": "#111827",
  "warnColorDark": "#FF3B5B",
  "fontColorDark": "#FFFFFF",
  "disableWatermark": true,
  "themeMode": "THEME_MODE_UNSPECIFIED"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "primaryColor": "#353535",
  "hideLoginNameSuffix": true,
  "warnColor": "#CD3D56",
  "backgroundColor": "#FAFAFA",
  "fontColor": "#000000",
  "primaryColorDark": "#BBBAFA",
  "backgroundColorDark": "#111827",
  "warnColorDark": "#FF3B5B",
  "fontColorDark": "#FFFFFF",
  "disableWatermark": true,
  "themeMode": "THEME_MODE_UNSPECIFIED"
}
ResponseClear

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