White Label Admin - Get white label information

White label admin only API to get the white label information.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

whitelabelWhitelabel (object)

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "whitelabel": {
    "name": "text",
    "domain": "text",
    "theme": {
      "name": "text",
      "favicon": {
        "favicon32": "text",
        "favicon57": "text",
        "favicon76": "text",
        "favicon96": "text",
        "favicon120": "text",
        "favicon128": "text",
        "favicon144": "text",
        "favicon152": "text",
        "favicon180": "text",
        "favicon228": "text"
      },
      "logos": {
        "primary": "text",
        "primaryPng": "text",
        "primaryWhite": "text",
        "loginLogo": "text",
        "loginLogoWhite": "text",
        "mark": "text",
        "markWhite": "text",
        "deviceLogo": "text"
      },
      "colors": {
        "primaryColor": "text",
        "primaryColorRgb": [
          0
        ],
        "primaryColorGradientEnd": "text"
      }
    },
    "identityProviders": [
      "text"
    ],
    "allowPasswordAuth": false,
    "deploymentTargets": [
      "text"
    ],
    "allDeploymentTargets": [
      "text"
    ],
    "customDeploymentBlocks": [
      {
        "name": "text",
        "id": 0
      }
    ],
    "deploymentOptionsOrder": [
      "org-1"
    ],
    "allowSignup": false,
    "allowFreeProjects": false,
    "exposePublicProjects": false,
    "defaultDeploymentTarget": "C++ Library",
    "supportedProjectTypes": [
      "kws"
    ],
    "allowNewProjectUi": false,
    "learningBlocks": [
      "text"
    ],
    "allLearningBlocks": [
      {
        "title": "text",
        "type": "text"
      }
    ],
    "developmentBoards": [
      {
        "name": "text",
        "image": "text",
        "docsUrl": "text"
      }
    ],
    "allDevelopmentBoards": [
      {
        "name": "text",
        "image": "text",
        "docsUrl": "text"
      }
    ]
  }
}

PreviousOrganization metrics NextWhite Label Admin - Update white label information

Last updated 2 months ago

{ "success": false, "error": "text", "whitelabel": { "name": "text", "domain": "text", "theme": { "name": "text", "favicon": { "favicon32": "text", "favicon57": "text", "favicon76": "text", "favicon96": "text", "favicon120": "text", "favicon128": "text", "favicon144": "text", "favicon152": "text", "favicon180": "text", "favicon228": "text" }, "logos": { "primary": "text", "primaryPng": "text", "primaryWhite": "text", "loginLogo": "text", "loginLogoWhite": "text", "mark": "text", "markWhite": "text", "deviceLogo": "text" }, "colors": { "primaryColor": "text", "primaryColorRgb": [ 0 ], "primaryColorGradientEnd": "text" } }, "identityProviders": [ "text" ], "allowPasswordAuth": false, "deploymentTargets": [ "text" ], "allDeploymentTargets": [ "text" ], "customDeploymentBlocks": [ { "name": "text", "id": 0 } ], "deploymentOptionsOrder": [ "org-1" ], "allowSignup": false, "allowFreeProjects": false, "exposePublicProjects": false, "defaultDeploymentTarget": "C++ Library", "supportedProjectTypes": [ "kws" ], "allowNewProjectUi": false, "learningBlocks": [ "text" ], "allLearningBlocks": [ { "title": "text", "type": "text" } ], "developmentBoards": [ { "name": "text", "image": "text", "docsUrl": "text" } ], "allDevelopmentBoards": [ { "name": "text", "image": "text", "docsUrl": "text" } ] } }