Skip to main content

​
Teams

A Team is an organizational unit used to group users and control access to data assets. Teams support a hierarchical structure that mirrors your organization.
Entity schema follows the OpenMetadata Standard.

​
Entity Hierarchy

Teams can be nested in a strict hierarchy: 
Organization
└── BusinessUnit
    └── Division
        └── Department
            └── Group (this is the most common team type)

​
Team Types

TypeDescription
OrganizationTop-level entity representing the entire organization
BusinessUnitA major business unit within the organization
DivisionA division within a business unit
DepartmentA department within a division
GroupThe most granular team type, typically used for day-to-day access control

​
Fully Qualified Name

The FQN format for a team is simply: 
teamName
For example: Accounting

​
API Endpoints

MethodEndpointDescription
POST/v1/teamsCreate a team
GET/v1/teamsList teams
GET/v1/teams/{id}Get by ID
GET/v1/teams/name/{fqn}Get by FQN
PATCH/v1/teams/{id}Update by ID
DELETE/v1/teams/{id}Delete by ID
PUT/v1/teams/restoreRestore soft-deleted team
GET/v1/teams/{id}/versionsList versions
GET/v1/teams/{id}/versions/{version}Get specific version