Skip to content

Tenant Domain

Overview

The Tenant Domain handles the multi-tenancy architecture of the platform. It provides strict data isolation by managing Organizations, Workspaces, and custom Role-Based Access Control (RBAC) matrices.

Key Features

  • Workspace Isolation: Allows an organization to create isolated environments (workspaces) for different teams, brands, or geographical regions.
  • Resource Assignment: Endpoints to bind specific locations, channels, and members to a target workspace.
  • Role Management: Define custom roles and permission matrices specific to an organization.

Routes

  • GET, POST /organizations/:orgId/roles - Manage organization-level roles.
  • GET /organizations/:orgId/roles-matrix - Retrieve the permission matrix for roles.
  • GET, POST /organizations/:orgId/workspaces - Create and list workspaces within an organization.
  • POST /workspaces/:workspaceId/members - Invite or assign members to a workspace.
  • POST /workspaces/:workspaceId/locations - Assign physical locations to a workspace.
  • POST /workspaces/:workspaceId/channels - Assign playback channels to a workspace.

Changelog

Date Author Change
2026-06-16 Pin Created the openapi