Get the current active branding settings​
Return the current active branding settings for the requested context
Query Parameters
- 200
- 403
- 404
- default
OK
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
lightTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
darkTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
url to the font used
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
boolean to disable the watermark
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_LIGHT
, THEME_MODE_DARK
]
Default value: THEME_MODE_UNSPECIFIED
states whether both or only dark or light theme will be used
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.925Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"lightTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"darkTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"fontUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/font-180950243237405441",
"hideLoginNameSuffix": true,
"disableWatermark": true,
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"themeMode": "THEME_MODE_UNSPECIFIED"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
lightTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
darkTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
url to the font used
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
boolean to disable the watermark
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_LIGHT
, THEME_MODE_DARK
]
Default value: THEME_MODE_UNSPECIFIED
states whether both or only dark or light theme will be used
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.926Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"lightTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"darkTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"fontUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/font-180950243237405441",
"hideLoginNameSuffix": true,
"disableWatermark": true,
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"themeMode": "THEME_MODE_UNSPECIFIED"
}
}
Schema
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
settings object
lightTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
darkTheme object
hex value for primary color
hex value for background color
hex value for warn color
hex value for font color
url to the logo
url to the icon
url to the font used
hides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
boolean to disable the watermark
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED
, RESOURCE_OWNER_TYPE_INSTANCE
, RESOURCE_OWNER_TYPE_ORG
]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the setting is managed on the organization or on the instance
Possible values: [THEME_MODE_UNSPECIFIED
, THEME_MODE_AUTO
, THEME_MODE_LIGHT
, THEME_MODE_DARK
]
Default value: THEME_MODE_UNSPECIFIED
states whether both or only dark or light theme will be used
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.926Z",
"resourceOwner": "69629023906488334"
},
"settings": {
"lightTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"darkTheme": {
"primaryColor": "#5469d4",
"backgroundColor": "#FAFAFA",
"warnColor": "#CD3D56",
"fontColor": "#000000",
"logoUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/logo-180950416321494657",
"iconUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/icon-180950498874178817"
},
"fontUrl": "https://acme.com/assets/v1/165617850692654601/policy/label/font-180950243237405441",
"hideLoginNameSuffix": true,
"disableWatermark": true,
"resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED",
"themeMode": "THEME_MODE_UNSPECIFIED"
}
}
Returned when the user does not have permission to access the resource.
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"
}
]
}
Returned when the resource does not exist.
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"
}
]
}
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"
}
]
}