Sign in

v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
🧩 Branding

Update web interface customization

change color, logo, label etc.

post/branding

Request body

displayBarboolean required

Whether header bar is displayed or not

displayLabelboolean required

Whether header bar's label is displayed or not

labelTextstring required

The header bar's label title

displayBarLoginboolean required

Whether header bar is displayed in login page or not

displayMotdboolean required

Whether the message of the day is displayed in login page or not

motdstring required

Message of the day in login page

Example request

{
  "labelText": "Production",
  "barColor": {
    "red": 0.2,
    "blue": 0.235,
    "green": 0.01,
    "alpha": 0.5
  },
  "labelColor": {
    "red": 0.2,
    "blue": 0.235,
    "green": 0.01,
    "alpha": 0.5
  },
  "motd": "Welcome, please sign in:"
}

Response

Updated

result'success' | 'error' required

Result of the request

action'updateBRandingConf' required

The id of the action

Example response

{
  "data": {
    "branding": {
      "labelText": "Production",
      "barColor": {
        "red": 0.2,
        "blue": 0.235,
        "green": 0.01,
        "alpha": 0.5
      },
      "labelColor": {
        "red": 0.2,
        "blue": 0.235,
        "green": 0.01,
        "alpha": 0.5
      },
      "motd": "Welcome, please sign in:"
    }
  }
}