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
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.
- 200
- default
A successful response.
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
hex value for primary color
defines if the organization's admin changed the policy
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
hex value for warn color
hex value for background color
hex value for font color
hex value for the primary color dark theme
hex value for background color dark theme
hex value for warning color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_DARK
, THEME_MODE_LIGHT
]
Default value: THEME_MODE_UNSPECIFIED
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.680Z",
"changeDate": "2024-06-13T06:44:37.680Z",
"resourceOwner": "69629023906488334"
},
"primaryColor": "#5469d4",
"isDefault": true,
"hideLoginNameSuffix": true,
"warnColor": "#CD3D56",
"backgroundColor": "#FAFAFA",
"fontColor": "#000000",
"primaryColorDark": "#BBBAFA",
"backgroundColorDark": "#111827",
"warnColorDark": "#FF3B5B",
"fontColorDark": "#FFFFFF",
"disableWatermark": true,
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817",
"logoUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-dark-180950229376461345",
"iconUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-dark-180950243237405441",
"fontUrl": "string",
"themeMode": "THEME_MODE_UNSPECIFIED"
},
"isDefault": true
}
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
hex value for primary color
defines if the organization's admin changed the policy
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
hex value for warn color
hex value for background color
hex value for font color
hex value for the primary color dark theme
hex value for background color dark theme
hex value for warning color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_DARK
, THEME_MODE_LIGHT
]
Default value: THEME_MODE_UNSPECIFIED
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.681Z",
"changeDate": "2024-06-13T06:44:37.681Z",
"resourceOwner": "69629023906488334"
},
"primaryColor": "#5469d4",
"isDefault": true,
"hideLoginNameSuffix": true,
"warnColor": "#CD3D56",
"backgroundColor": "#FAFAFA",
"fontColor": "#000000",
"primaryColorDark": "#BBBAFA",
"backgroundColorDark": "#111827",
"warnColorDark": "#FF3B5B",
"fontColorDark": "#FFFFFF",
"disableWatermark": true,
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817",
"logoUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-dark-180950229376461345",
"iconUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-dark-180950243237405441",
"fontUrl": "string",
"themeMode": "THEME_MODE_UNSPECIFIED"
},
"isDefault": true
}
Schema
policy object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
hex value for primary color
defines if the organization's admin changed the policy
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
hex value for warn color
hex value for background color
hex value for font color
hex value for the primary color dark theme
hex value for background color dark theme
hex value for warning color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
hex value for font color dark theme
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_DARK
, THEME_MODE_LIGHT
]
Default value: THEME_MODE_UNSPECIFIED
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.681Z",
"changeDate": "2024-06-13T06:44:37.681Z",
"resourceOwner": "69629023906488334"
},
"primaryColor": "#5469d4",
"isDefault": true,
"hideLoginNameSuffix": true,
"warnColor": "#CD3D56",
"backgroundColor": "#FAFAFA",
"fontColor": "#000000",
"primaryColorDark": "#BBBAFA",
"backgroundColorDark": "#111827",
"warnColorDark": "#FF3B5B",
"fontColorDark": "#FFFFFF",
"disableWatermark": true,
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817",
"logoUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-dark-180950229376461345",
"iconUrlDark": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-dark-180950243237405441",
"fontUrl": "string",
"themeMode": "THEME_MODE_UNSPECIFIED"
},
"isDefault": true
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}