mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 18:32:19 +08:00
0166b6bcc6
* Update API docs for team groups search * update team sync doc * remove param block --------- Co-authored-by: Gabriel Mabille <gabriel.mabille@grafana.com>
201 lines
4.0 KiB
Markdown
201 lines
4.0 KiB
Markdown
---
|
|
aliases:
|
|
- ../../http_api/external_group_sync/
|
|
- ./external_group_sync/
|
|
canonical: /docs/grafana/latest/developers/http_api/team_sync/
|
|
description: Grafana Team Sync HTTP API
|
|
keywords:
|
|
- grafana
|
|
- http
|
|
- documentation
|
|
- api
|
|
- team
|
|
- teams
|
|
- group
|
|
- member
|
|
- enterprise
|
|
labels:
|
|
products:
|
|
- enterprise
|
|
- oss
|
|
title: Team Sync HTTP API
|
|
---
|
|
|
|
# Team Sync API
|
|
|
|
> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
|
|
|
|
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
|
|
|
|
## Get External Groups
|
|
|
|
`GET /api/teams/:teamId/groups`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#external-group-synchronization-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ---------------------- | -------- |
|
|
| teams.permissions:read | teams:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/teams/1/groups HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **401** - Unauthorized
|
|
- **403** - Permission denied
|
|
|
|
## Add External Group
|
|
|
|
`POST /api/teams/:teamId/groups`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#external-group-synchronization-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ----------------------- | -------- |
|
|
| teams.permissions:write | teams:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
POST /api/teams/1/groups HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer YWRtaW46YWRtaW4=
|
|
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Group is already added to this team
|
|
- **401** - Unauthorized
|
|
- **403** - Permission denied
|
|
- **404** - Team not found
|
|
|
|
## Remove External Group
|
|
|
|
`DELETE /api/teams/:teamId/groups?groupId=external-group-id`
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#external-group-synchronization-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ----------------------- | -------- |
|
|
| teams.permissions:write | teams:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
DELETE /api/teams/1/groups?groupId=cn%3Deditors%2Cou%3Dgroups%2Cdc%3Dgrafana%2Cdc%3Dorg HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **401** - Unauthorized
|
|
- **403** - Permission denied
|
|
- **404** - Team not found/Group not found
|
|
|
|
## Search Team Groups
|
|
|
|
`GET /api/teams/:teamId/groups/search`
|
|
|
|
Search for team groups with pagination support.
|
|
|
|
**Required permissions**
|
|
|
|
| Action | Scope |
|
|
| ---------------------- | -------- |
|
|
| teams.permissions:read | teams:\* |
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/teams/1/groups/search?name=editors&query=group&page=1&perpage=10 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Bad Request (invalid team ID format or missing query parameter)
|
|
- **401** - Unauthorized
|
|
- **403** - Permission denied
|
|
- **500** - Internal Server Error
|