mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
Wim Van LaerandGitHub
699ed17918
# Which Problems Are Solved naming inconsistencies: Configuration <-> Settings # How the Problems Are Solved # Additional Changes # Additional Context - Closes #11282
59 lines
2.7 KiB
Plaintext
59 lines
2.7 KiB
Plaintext
---
|
|
title: Brand Customization
|
|
---
|
|
|
|
ZITADEL offers various customization options for your projects brand design. The branding can be configured on two different levels.
|
|
The settings on the instance level will set the default settings, which are triggered for all users if not overwritten on an organization specifically.
|
|
The second possibility is to configure it on each organization. This guide will describe the second possibility.
|
|
For this head over to the Branding Setting on your Organization Page.
|
|
|
|
## How it works
|
|
|
|
You are able to customize the light and a dark mode separately.
|
|
All your changes will be shown in the preview window on the right side.
|
|
As soon as you are happy with your settings click the "Apply settings" button.
|
|
After this your settings will trigger in your system. The login and the emails will be sent with your branding.
|
|
|
|
## Settings
|
|
|
|
|
|
|
|
### Logo
|
|
|
|
Upload your logo for the chosen theme, as soon as it is uploaded the preview on the right side of the screen should show it.
|
|
|
|
### Colors
|
|
|
|
In the next part you can configure your colors.
|
|
Background color is self-explanatory, the primary color will be used for buttons, links and some highlights.
|
|
The warn color is used for all the error messages and warnings and the font color for texts.
|
|
|
|
### Font
|
|
|
|
Last step to apply to your branding is the font upload.
|
|
The best way is to upload a ttf file after a successful upload you will see it in the font part, but not in the preview.
|
|
|
|
### Advanced Settings
|
|
|
|
In the advanced behavior you can choose if the loginname suffix (domain e.g. [email protected]) should be shown in the loginname screen or not and if the “ZITADEL watermark” should be hidden.
|
|
|
|
## Trigger the private labeling for the login
|
|
|
|
If you like to trigger your settings for your applications you have different possibilities.
|
|
|
|
### 1. Primary Domain Scope
|
|
|
|
Send a [reserved scope](/apis/openidoauth/scopes) with your [authorization request](../../integrate/login/oidc/login-users) to trigger your organization.
|
|
The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to log in.
|
|
|
|
You can use our [OpenID Authentication Request Playground](https://zitadel.com/playgrounds/oidc) to learn more about how to trigger an [organization's policies and branding](https://zitadel.com/playgrounds/oidc#organization-policies-and-branding).
|
|
|
|
### 2. Setting on your Project
|
|
|
|
Set the private labeling setting on your project to define which branding should trigger.
|
|
|
|
## Reset to default
|
|
|
|
If you don't like your customization anymore click the "reset policy" button.
|
|
All your settings will be removed and the default settings of the system will trigger.
|