Get Label Policy
Returns the label settings that should be used for the authenticated user. It is set either on an instance or organization level. This policy defines the branding, colors, fonts, images, etc.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprimaryColor hex value for primary colorhex value for primary color
isDefault defines if the organization's admin changed the policydefines if the organization's admin changed the policy
hideLoginNameSuffix hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is sethides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
warnColor hex value for secondary colorhex value for warn color
backgroundColor hex value for background colorhex value for background color
fontColor hex value for font colorhex value for font color
primaryColorDark hex value for primary color dark themehex value for the primary color dark theme
backgroundColorDark hex value for background color dark themehex value for background color dark theme
warnColorDark hex value for warning color dark themehex value for warning color dark theme
fontColorDark hex value for font color dark themehex value for font color dark theme
disableWatermark booleanlogoUrl stringhex value for font color dark theme
iconUrl stringhex value for font color dark theme
logoUrlDark stringhex value for font color dark theme
iconUrlDark stringhex value for font color dark theme
fontUrl string
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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"
}
}
- Schema
- Example (from schema)
Schema
policy object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprimaryColor hex value for primary colorhex value for primary color
isDefault defines if the organization's admin changed the policydefines if the organization's admin changed the policy
hideLoginNameSuffix hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is sethides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
warnColor hex value for secondary colorhex value for warn color
backgroundColor hex value for background colorhex value for background color
fontColor hex value for font colorhex value for font color
primaryColorDark hex value for primary color dark themehex value for the primary color dark theme
backgroundColorDark hex value for background color dark themehex value for background color dark theme
warnColorDark hex value for warning color dark themehex value for warning color dark theme
fontColorDark hex value for font color dark themehex value for font color dark theme
disableWatermark booleanlogoUrl stringhex value for font color dark theme
iconUrl stringhex value for font color dark theme
logoUrlDark stringhex value for font color dark theme
iconUrlDark stringhex value for font color dark theme
fontUrl string
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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"
}
}
- Schema
- Example (from schema)
Schema
policy object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprimaryColor hex value for primary colorhex value for primary color
isDefault defines if the organization's admin changed the policydefines if the organization's admin changed the policy
hideLoginNameSuffix hides the org suffix on the login form if the scope \"urn:zitadel:iam:org:domain:primary:{domainname}\" is sethides the org suffix on the login form if the scope "urn:zitadel:iam:org:domain:primary:{domainname}" is set
warnColor hex value for secondary colorhex value for warn color
backgroundColor hex value for background colorhex value for background color
fontColor hex value for font colorhex value for font color
primaryColorDark hex value for primary color dark themehex value for the primary color dark theme
backgroundColorDark hex value for background color dark themehex value for background color dark theme
warnColorDark hex value for warning color dark themehex value for warning color dark theme
fontColorDark hex value for font color dark themehex value for font color dark theme
disableWatermark booleanlogoUrl stringhex value for font color dark theme
iconUrl stringhex value for font color dark theme
logoUrlDark stringhex value for font color dark theme
iconUrlDark stringhex value for font color dark theme
fontUrl string
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}