White Label Admin - Get white label information

White Label Admin - Get white label information

get

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

Authorizations
Path parameters
organizationIdintegerRequired

Organization ID

Responses
200
OK
application/json
Responseall of
get
GET /v1/api/organizations/{organizationId}/whitelabel HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
200

OK

{
  "success": true,
  "error": "text",
  "whitelabel": {
    "id": 1,
    "name": "text",
    "domain": "text",
    "ownerOrganizationId": 1,
    "themeId": 1,
    "theme": {
      "id": 1,
      "ownerUserId": 1,
      "ownerOrganizationId": 1,
      "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": [
          1
        ],
        "primaryColorGradientEnd": "text"
      }
    },
    "identityProviders": [
      "text"
    ],
    "allowPasswordAuth": true,
    "deploymentTargets": [
      "text"
    ],
    "allDeploymentTargets": [
      "text"
    ],
    "customDeploymentBlocks": [
      {
        "name": "text",
        "id": 1
      }
    ],
    "deploymentOptionsOrder": [
      "org-1"
    ],
    "allowSignup": true,
    "allowFreeProjects": true,
    "exposePublicProjects": true,
    "defaultDeploymentTarget": "C++ Library",
    "supportedProjectTypes": [
      "kws"
    ],
    "allowNewProjectUi": true,
    "learningBlocks": [
      "text"
    ],
    "allLearningBlocks": [
      {
        "title": "text",
        "type": "text"
      }
    ],
    "developmentBoards": [
      {
        "id": 1,
        "name": "text",
        "image": "text",
        "docsUrl": "text"
      }
    ],
    "allDevelopmentBoards": [
      {
        "id": 1,
        "name": "text",
        "image": "text",
        "docsUrl": "text"
      }
    ],
    "organizationsLimit": 1,
    "disablePublicEntities": true
  }
}

Last updated

Was this helpful?