Branding

White-label branding assets and configuration.

Returns branding configuration.

get

Returns current branding configuration.

Responses

200

Successful operation.

application/json

headerColorstringRequired

primaryColorstringRequired

companyNamestringRequired

companyLogoUrlstringRequired

loginBannerUrlstringRequired

faviconUrlstringRequired

headerColor1stringRequired

termsAndConditionsstringRequired

useCustomMenuColorsbooleanRequired

useSolidBackgroundbooleanRequired

500

Internal server error.

application/json

get/branding

HTTPcURLJavaScriptPython

GET /api/v1/branding HTTP/1.1
Accept: */*

{
  "headerColor": "#0031ff",
  "headerColor1": "#8259ef",
  "primaryColor": "#0031ff",
  "companyName": "GUARDIAN",
  "companyLogoUrl": "/assets/images/logo.png",
  "loginBannerUrl": "/assets/bg.jpg",
  "faviconUrl": "favicon.ico",
  "termsAndConditions": "Lorem Ipsum Version Introduction..."
}

Update branding.

post

Update branding. Only users with the Standard Registry role are allowed to make the request.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

headerColorstringRequired

primaryColorstringRequired

companyNamestringRequired

companyLogoUrlstringRequired

loginBannerUrlstringRequired

faviconUrlstringRequired

headerColor1stringRequired

termsAndConditionsstringRequired

useCustomMenuColorsbooleanRequired

useSolidBackgroundbooleanRequired

Responses

204

Branding updated successfully. No response body.

No content

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/branding

HTTPcURLJavaScriptPython

POST /api/v1/branding HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "headerColor": "#0031ff",
  "headerColor1": "#8259ef",
  "primaryColor": "#0031ff",
  "companyName": "GUARDIAN",
  "companyLogoUrl": "/assets/images/logo.png",
  "loginBannerUrl": "/assets/bg.jpg",
  "faviconUrl": "favicon.ico"
}

No content