Team management, membership, and team-level role assignment.
/org/teamsList teams
Returns all teams within the organization, including their member counts and descriptions.
Parameters
pageinteger
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
"int32"11limitinteger
The maximum number of items to list.
"int32"0100100sortBystring
The field to sort by.
"name""email""name"sortDirectionstring
The direction to sort (ascending or descending).
"asc""desc""asc"Responses
Responses
A list of teams is returned.
/org/teamsCreate a team
Creates a new team within the organization. Teams are used to group members and control access to clusters, jobs, and queries.
Request Body
Responses
Responses
Successfully created team.
/org/teams/{team}Describe a team
Returns the full details of a team, including its name, description, and member count.
Responses
Responses
The team response.
/org/teams/{team}Delete a team
Permanently removes a team and all its member assignments. Resources previously shared with this team become inaccessible to its former members unless they have access through another team.
Responses
Responses
The requested operation was done successfully.
/org/teams/{team}Update a team
Modifies a team's metadata such as its name or description.
Request Body
Responses
Responses
Successfully updated team.
/org/teams/{team}/membersList team members
Returns all members of a team, including their assigned team roles.
Parameters
pageinteger
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
"int32"11limitinteger
The maximum number of items to list.
"int32"0100100sortBystring
The field to sort by.
"name""email""name"sortDirectionstring
The direction to sort (ascending or descending).
"asc""desc""asc"Responses
Responses
A list of team members is returned.
/org/teams/{team}/members/{member}Add a team member
Adds an existing organization member to a team, granting them access to the team's associated resources (clusters, jobs, queries). If roleIds is omitted or empty, the team's configured default role is used.
Request Body
Responses
Responses
The member was added to the team successfully.
/org/teams/{team}/members/{member}Remove a team member
Removes a member from a team. The member loses access to resources shared with this team unless they have access through another team.
Responses
Responses
The member was removed from the team successfully.
/org/teams/{team}/members/{member}/rolesUpdate team member roles
Syncs the team roles for a team member by replacing all existing roles with the provided list.
At least one role must be provided; to remove a member from the team entirely use the
remove-team-member endpoint instead.
The member must be a member of the team before roles can be assigned.
Request Body
Responses
Responses
The requested operation was done successfully.