Edge Impulse Organizations API

The Organizations API from Edge Impulse — 60 operation(s) for organizations.

OpenAPI Specification

edge-impulse-organizations-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Edge Impulse Organizations API
  version: 1.0.0
servers:
- url: https://studio.edgeimpulse.com/v1
security:
- ApiKeyAuthentication: []
- JWTAuthentication: []
- JWTHttpHeaderAuthentication: []
tags:
- name: Organizations
paths:
  /api/organizations:
    get:
      summary: List active organizations
      x-skip-route: true
      description: Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.
      tags:
      - Organizations
      operationId: listOrganizations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationsResponse'
  /api/organizations/create:
    post:
      summary: Create new organization
      description: Create a new organization. This is an internal API.
      x-internal-api: true
      tags:
      - Organizations
      x-middleware:
      - OrganizationAllowDeveloperProfile
      operationId: createOrganization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrganizationResponse'
  /api/organizations/{organizationId}:
    get:
      summary: Organization information
      description: List all information about this organization.
      tags:
      - Organizations
      x-middleware:
      - OrganizationAllowDeveloperProfile
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      operationId: getOrganizationInfo
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationInfoResponse'
    post:
      summary: Update organization
      description: Update organization properties such as name and logo.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      operationId: updateOrganization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
    delete:
      summary: Remove organization
      description: Remove the current organization, and all data associated with it. This is irrevocable!
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      operationId: deleteOrganization
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/trial/request-extension:
    post:
      summary: Request trial extension
      description: Request an extension for an enterprise trial.
      tags:
      - Organizations
      operationId: requestEnterpriseTrialExtension
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnterpriseUpgradeOrTrialExtensionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/metrics:
    get:
      summary: Organization metrics
      description: Get general metrics for this organization.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ExcludeEdgeImpulseUsersParameter'
      - $ref: '#/components/parameters/ProjectVisibilityParameter'
      operationId: getOrganizationMetrics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationMetricsResponse'
  /api/organizations/{organizationId}/request-hr-block-license:
    post:
      summary: Request HR block license
      description: Request a license required for the deployment of an impulse containing the Edge Impulse HR block.
      tags:
      - Organizations
      operationId: requestEnterpriseHrBlockLicense
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/limits-request:
    post:
      summary: Request organization limits increase
      description: 'Request an increase in the limits for this organization. Available limits are: users, projects, compute, storage.'
      tags:
      - Organizations
      operationId: requestEnterpriseLimitsIncrease
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnterpriseLimitsIncreaseRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel:
    get:
      summary: White Label Admin - Get white label information
      description: White label admin only API to get the white label information.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetInfo
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWhitelabelResponse'
    put:
      summary: White Label Admin - Update white label information
      description: White label admin only API to update the white label information.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      operationId: whitelabelAdminUpdateInfo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWhitelabelRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/deploymentTargets:
    post:
      summary: White Label Admin - Update deployment targets
      description: White label admin only API to update some or all of the deployment targets enabled for this white label.
      operationId: whitelabelAdminUpdateDeploymentTargets
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWhitelabelDeploymentTargetsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/deploymentTargets/default:
    post:
      summary: White Label Admin - Update default deployment target
      description: White label admin only API to update the default deployment target for this white label.
      operationId: whitelabelAdminUpdateDefaultDeploymentTarget
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWhitelabelDefaultDeploymentTargetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder:
    post:
      summary: White Label Admin - Update the order of deployment options in the deployment view
      description: White label admin only API to customize the order of deployment options in the deployment view for this white label.
      operationId: whitelabelAdminUpdateDeploymentOptionsOrder
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWhitelabelDeploymentOptionsOrderRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/learningBlocks:
    post:
      summary: White Label Admin - Update learning blocks
      description: White label admin only API to update some or all of the learning blocks enabled for this white label.
      operationId: whitelabelAdminUpdateLearningBlocks
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWhitelabelLearningBlocksRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/theme/logo:
    post:
      summary: White Label Admin - Update theme logo
      description: White label admin only API to update the white label theme logo.
      operationId: whitelabelAdminUpdateThemeLogo
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadAssetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadAssetResponse'
  /api/organizations/{organizationId}/whitelabel/theme/deviceLogo:
    post:
      summary: White Label Admin - Update theme device logo
      description: White label admin only API to update the white label theme device logo.
      operationId: whitelabelAdminUpdateThemeDeviceLogo
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadAssetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadAssetResponse'
  /api/organizations/{organizationId}/whitelabel/theme/colors:
    post:
      summary: White Label Admin - Update theme colors
      description: White label admin only API to update some or all theme colors.
      operationId: whitelabelAdminUpdateThemeColors
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateThemeColorsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/theme/favicon:
    post:
      summary: White Label Admin - Update theme favicon
      description: White label admin only API to update the theme favicon.
      operationId: whitelabelAdminUpdateThemeFavicon
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadImageRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/metrics:
    get:
      summary: White Label Admin - Get global white label metrics
      description: White label admin only API to get global metrics.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetMetrics
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGetMetricsResponse'
  /api/organizations/{organizationId}/whitelabel/users:
    get:
      summary: White Label Admin - Get all white label users
      description: White label admin only API to get the list of all registered users.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetUsers
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/FiltersActiveParameter'
      - $ref: '#/components/parameters/FiltersTierParameter'
      - $ref: '#/components/parameters/FieldsParameter'
      - $ref: '#/components/parameters/SortQueryParameter'
      - $ref: '#/components/parameters/FiltersQueryParameter'
      - $ref: '#/components/parameters/LimitResultsParameter'
      - $ref: '#/components/parameters/OffsetResultsParameter'
      - $ref: '#/components/parameters/SearchQueryParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGetUsersResponse'
  /api/organizations/{organizationId}/whitelabel/users/{userId}:
    get:
      summary: White Label Admin - Get a white label user
      description: White label admin only API to get information about a user.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetUser
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGetUserResponse'
    post:
      summary: White Label Admin - Update white label user
      description: White label admin only API to update user properties.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminUpdateUser
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminUpdateUserRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
    delete:
      summary: Delete a user
      description: White label admin only API to delete a user.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminDeleteUser
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/users/{userId}/metrics:
    get:
      summary: White Label Admin - Get white label user metrics
      description: White label admin only API to get marketing metrics about a user.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetUserMetrics
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGetUserMetricsResponse'
  /api/organizations/{organizationId}/whitelabel/users/{userId}/jobs:
    get:
      summary: White Label Admin - Get user jobs
      description: White label admin only  API to get the list of all project jobs for a user.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetUserJobs
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      - $ref: '#/components/parameters/LimitResultsParameter'
      - $ref: '#/components/parameters/OffsetResultsParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
  /api/organizations/{organizationId}/whitelabel/projects:
    get:
      summary: White Label Admin - Get all white label projects
      description: White label admin only API to get the list of all projects.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetProjects
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/FiltersActiveParameter'
      - $ref: '#/components/parameters/SortQueryParameter'
      - $ref: '#/components/parameters/FiltersQueryParameter'
      - $ref: '#/components/parameters/LimitResultsParameter'
      - $ref: '#/components/parameters/OffsetResultsParameter'
      - $ref: '#/components/parameters/SearchQueryParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminListProjectsResponse'
    post:
      summary: White Label Admin - Create a new project within white label context.
      description: Create a new free tier project. This is an API only available to white label admins.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminCreateProject
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminCreateProjectRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProjectResponse'
  /api/organizations/{organizationId}/whitelabel/projects/{projectId}:
    get:
      summary: White Label Admin - Get a white label project
      description: White label admin only API to get project information.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetProject
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectInfoResponse'
    post:
      summary: White Label Admin - Update white label project
      description: White label admin only API to update project properties.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminUpdateProject
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProjectRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
    delete:
      summary: White Label Admin - Delete a project
      description: White label admin only API to delete a project.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminDeleteProject
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys:
    post:
      summary: White Label Admin - Add Project API key
      description: White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminAddProjectApiKey
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminAddProjectApiKeyRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiKeyResponse'
  /api/organizations/{organizationId}/whitelabel/projects/{projectId}/members:
    post:
      summary: White Label Admin - Add user to a project
      description: White label admin only API to add a user to a project. If no user is provided, the current user is used.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      operationId: whitelabelAdminAddUserToProject
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminAddProjectUserRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}:
    delete:
      summary: White Label Admin - Remove user from a project
      description: White label admin only API to remove a user from a project.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/UserIdParameter'
      operationId: whitelabelAdminRemoveUserFromProject
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs:
    get:
      summary: White Label Admin - Get project jobs
      description: White label admin only API to get the list of all jobs for a project.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/ProjectIdParameter'
      - $ref: '#/components/parameters/LimitResultsParameter'
      - $ref: '#/components/parameters/OffsetResultsParameter'
      operationId: whitelabelAdminGetProjectJobs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
  /api/organizations/{organizationId}/whitelabel/development-boards:
    post:
      summary: White Label Admin - Add a development board to a whitelabel
      description: White label admin only API to add a development board.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      operationId: whitelabelAdminAddDevelopmentBoard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevelopmentBoardRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCreatedResponse'
  /api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}:
    put:
      summary: White Label Admin - Update a development board in a whitelabel
      description: White label admin only API to update a development board.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/DevelopmentBoardIdParameter'
      operationId: whitelabelAdminUpdateDevelopmentBoard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevelopmentBoardRequestUpdate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
    delete:
      summary: White Label Admin - Remove a development board from a whitelabel
      description: White label admin only API to remove a development board.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/DevelopmentBoardIdParameter'
      operationId: whitelabelAdminRemoveDevelopmentBoard
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericApiResponse'
  /api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image:
    post:
      summary: White Label Admin - Update the image of a whitelabel development board
      description: White label admin only API to update the image of a development board.
      operationId: whitelabelAdminUpdateDevelopmentBoardImage
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/DevelopmentBoardIdParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadAssetRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadAssetResponse'
  /api/organizations/{organizationId}/whitelabel/organizations:
    get:
      summary: White Label Admin - Get all organizations within a white label
      description: White label admin only API to get the list of all organizations.
      tags:
      - Organizations
      x-middleware:
      - OrganizationRequiresAdmin
      - OrganizationRequiresWhitelabelAdmin
      operationId: whitelabelAdminGetOrganizations
      parameters:
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/FiltersActiveParameter'
      - $ref: '#/components/parameters/FiltersIncludeDeletedParameter'
      - $ref: '#/components/parameters/SortQueryParameter'
      - $ref: '#/components/parameters/FiltersQueryParameter'
      - $ref: '#/components/parameters/LimitResultsParameter'
      - $ref: '#/components/parameters/OffsetResultsParameter'
      - $ref: '#/components/parameters/SearchQueryParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/c

# --- truncated at 32 KB (158 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/edge-impulse/refs/heads/main/openapi/edge-impulse-organizations-api-openapi.yml