Skip to main content

Update Labeling/Branding Settings​

Update the preview private labeling/branding configured on the organization. The settings will trigger if the organization has been identified (organization scope, user). 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.

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.

Request Body required
    primaryColor string
    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

A successful response.

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
PUT /policies/label

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
x-zitadel-orgid — header
Content-Type
Body required
{

  "primaryColor": "string",

  "hideLoginNameSuffix": true,

  "warnColor": "#CD3D56",

  "backgroundColor": "#FAFAFA",

  "fontColor": "#000000",

  "primaryColorDark": "#BBBAFA",

  "backgroundColorDark": "#111827",

  "warnColorDark": "#FF3B5B",

  "fontColorDark": "#FFFFFF",

  "disableWatermark": true,

  "themeMode": "THEME_MODE_UNSPECIFIED"

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/policies/label' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "primaryColor": "string",
  "hideLoginNameSuffix": true,
  "warnColor": "#CD3D56",
  "backgroundColor": "#FAFAFA",
  "fontColor": "#000000",
  "primaryColorDark": "#BBBAFA",
  "backgroundColorDark": "#111827",
  "warnColorDark": "#FF3B5B",
  "fontColorDark": "#FFFFFF",
  "disableWatermark": true,
  "themeMode": "THEME_MODE_UNSPECIFIED"
}'