curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel \
--header 'x-api-key: <api-key>'{
"success": true,
"error": "<string>",
"whitelabel": {
"id": 123,
"name": "<string>",
"domain": "<string>",
"themeId": 123,
"identityProviders": [
"<string>"
],
"allowPasswordAuth": true,
"deploymentTargets": [
"<string>"
],
"allDeploymentTargets": [
"<string>"
],
"allowSignup": true,
"allowFreeProjects": true,
"supportedProjectTypes": [
"kws"
],
"allowNewProjectUi": true,
"learningBlocks": [
"<string>"
],
"allLearningBlocks": [
{
"title": "<string>",
"type": "<string>"
}
],
"developmentBoards": [
{
"id": 123,
"name": "<string>",
"image": "<string>",
"docsUrl": "<string>"
}
],
"allDevelopmentBoards": [
{
"id": 123,
"name": "<string>",
"image": "<string>",
"docsUrl": "<string>"
}
],
"ownerOrganizationId": 123,
"theme": {
"id": 123,
"name": "<string>",
"favicon": {
"favicon32": "<string>",
"favicon57": "<string>",
"favicon76": "<string>",
"favicon96": "<string>",
"favicon120": "<string>",
"favicon128": "<string>",
"favicon144": "<string>",
"favicon152": "<string>",
"favicon180": "<string>",
"favicon228": "<string>"
},
"logos": {
"primary": "<string>",
"primaryPng": "<string>",
"primaryWhite": "<string>",
"loginLogo": "<string>",
"loginLogoWhite": "<string>",
"mark": "<string>",
"markWhite": "<string>",
"deviceLogo": "<string>"
},
"colors": {
"primaryColor": "<string>",
"primaryColorRgb": [
123
],
"primaryColorGradientEnd": "<string>"
},
"ownerUserId": 123,
"ownerOrganizationId": 123
},
"customDeploymentBlocks": [
{
"name": "<string>",
"id": 123
}
],
"deploymentOptionsOrder": [
"org-1"
],
"exposePublicProjects": true,
"defaultDeploymentTarget": "C++ Library",
"organizationsLimit": 123,
"disablePublicEntities": true
}
}White label admin only API to get the white label information.
curl --request GET \
--url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel \
--header 'x-api-key: <api-key>'{
"success": true,
"error": "<string>",
"whitelabel": {
"id": 123,
"name": "<string>",
"domain": "<string>",
"themeId": 123,
"identityProviders": [
"<string>"
],
"allowPasswordAuth": true,
"deploymentTargets": [
"<string>"
],
"allDeploymentTargets": [
"<string>"
],
"allowSignup": true,
"allowFreeProjects": true,
"supportedProjectTypes": [
"kws"
],
"allowNewProjectUi": true,
"learningBlocks": [
"<string>"
],
"allLearningBlocks": [
{
"title": "<string>",
"type": "<string>"
}
],
"developmentBoards": [
{
"id": 123,
"name": "<string>",
"image": "<string>",
"docsUrl": "<string>"
}
],
"allDevelopmentBoards": [
{
"id": 123,
"name": "<string>",
"image": "<string>",
"docsUrl": "<string>"
}
],
"ownerOrganizationId": 123,
"theme": {
"id": 123,
"name": "<string>",
"favicon": {
"favicon32": "<string>",
"favicon57": "<string>",
"favicon76": "<string>",
"favicon96": "<string>",
"favicon120": "<string>",
"favicon128": "<string>",
"favicon144": "<string>",
"favicon152": "<string>",
"favicon180": "<string>",
"favicon228": "<string>"
},
"logos": {
"primary": "<string>",
"primaryPng": "<string>",
"primaryWhite": "<string>",
"loginLogo": "<string>",
"loginLogoWhite": "<string>",
"mark": "<string>",
"markWhite": "<string>",
"deviceLogo": "<string>"
},
"colors": {
"primaryColor": "<string>",
"primaryColorRgb": [
123
],
"primaryColorGradientEnd": "<string>"
},
"ownerUserId": 123,
"ownerOrganizationId": 123
},
"customDeploymentBlocks": [
{
"name": "<string>",
"id": 123
}
],
"deploymentOptionsOrder": [
"org-1"
],
"exposePublicProjects": true,
"defaultDeploymentTarget": "C++ Library",
"organizationsLimit": 123,
"disablePublicEntities": true
}
}Organization ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Show child attributes
List of deployment targets enabled for this white label
List of all supported deployment targets
kws, audio, object-detection, image, accelerometer, other Whether the new project UI should be enabled for this white label or not.
List of learning blocks enabled for this white label
Show child attributes
Show child attributes
Show child attributes
Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.
Deployment option name
The name of the default deployment target for this white label
"C++ Library"
The maximum number of organizations that can be created under this white label.
Whether public entities (like projects, user profiles, etc.) are disabled for this whitelabel instance.
Was this page helpful?