mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
GAS: Add HTTP API docs for group attribute sync (#96088)
add HTTP API docs for GAS
This commit is contained in:
Ieva
GitHub
parent
de6a37e1c5
commit
fa498e4836
@ -84,6 +84,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
Grafana Enterprise includes all of the Grafana OSS APIs as well as the following APIs:
|
||||
|
||||
- [Data source permissions API]({{< relref "datasource_permissions/" >}})
|
||||
- [Group attribute sync API]({{< relref "group_attribute_sync/" >}})
|
||||
- [License API]({{< relref "licensing/" >}})
|
||||
- [Query and resource caching API]({{< relref "query_and_resource_caching/" >}})
|
||||
- [Reporting API]({{< relref "reporting/" >}})
|
||||
|
||||
209
docs/sources/developers/http_api/group_attribute_sync.md
Normal file
209
docs/sources/developers/http_api/group_attribute_sync.md
Normal file
@ -0,0 +1,209 @@
|
||||
---
|
||||
description: Grafana Group Attribute Sync HTTP API
|
||||
keywords:
|
||||
- grafana
|
||||
- http
|
||||
- documentation
|
||||
- api
|
||||
- group
|
||||
- member
|
||||
- enterprise
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Group Attribute Sync HTTP API
|
||||
---
|
||||
|
||||
# Group attribute sync API
|
||||
|
||||
The Group Attribute Sync API allows you to configure [group attribute sync feature](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-security/configure-group-attribute-sync). This API is useful when you want to manage user roles based on group membership in an external system.
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise) and [Grafana Cloud](https://grafana.com/docs/grafana-cloud/)
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
This feature is behind the `groupAttributeSync` feature toggle.
|
||||
You can enable feature toggles through configuration file or environment variables. See configuration [docs](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#feature_toggles) for details.
|
||||
{{% /admonition %}}
|
||||
|
||||
## List group mappings
|
||||
|
||||
`GET /api/groupsync/groups`
|
||||
|
||||
**Required permissions**
|
||||
|
||||
| Action | Scope |
|
||||
| ----------------------- | ----- |
|
||||
| groupsync.mappings:read | n/a |
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
GET /api/groupsync/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
|
||||
|
||||
[
|
||||
{
|
||||
"groups": [
|
||||
{
|
||||
"groupID": "group 1",
|
||||
"mappings": {
|
||||
"1": {
|
||||
"roles": [
|
||||
"fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
|
||||
"my_custom_role",
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"groupID": "group 2",
|
||||
"mappings": {
|
||||
"1": {
|
||||
"roles": [
|
||||
"another_role",
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"total": 2
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** - Ok
|
||||
- **400** - Bad request
|
||||
- **401** - Unauthorized
|
||||
- **403** - Permission denied
|
||||
- **500** - Internal server error
|
||||
|
||||
## Create group mappings
|
||||
|
||||
`POST /api/groupsync/groups/:groupID`
|
||||
|
||||
**Required permissions**
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------ | ----- |
|
||||
| groupsync.mappings:write | n/a |
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
POST /api/groupsync/groups/my_group_id HTTP/1.1
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
||||
|
||||
{
|
||||
"roles": [
|
||||
"fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
|
||||
"my_custom_role_uid"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
|
||||
```http
|
||||
HTTP/1.1 200
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"message": "Group mappings created."
|
||||
}
|
||||
```
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **201** - Ok
|
||||
- **400** - Bad request
|
||||
- **401** - Unauthorized
|
||||
- **403** - Permission denied
|
||||
- **500** - Internal server error
|
||||
|
||||
## Update group mappings
|
||||
|
||||
`PUT /api/groupsync/groups/:groupID`
|
||||
|
||||
This endpoint will replace the existing mappings for the group with the new mappings provided in the request.
|
||||
|
||||
**Required permissions**
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------ | ----- |
|
||||
| groupsync.mappings:write | n/a |
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
PUT /api/groupsync/groups/my_group_id HTTP/1.1
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
||||
|
||||
{
|
||||
"roles": [
|
||||
"fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
|
||||
"my_custom_role_uid"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
|
||||
```http
|
||||
HTTP/1.1 200
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"message": "Group mappings set."
|
||||
}
|
||||
```
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **201** - Ok
|
||||
- **400** - Bad request
|
||||
- **401** - Unauthorized
|
||||
- **403** - Permission denied
|
||||
- **500** - Internal server error
|
||||
|
||||
## Remove group mappings
|
||||
|
||||
`DELETE /api/groupsync/groups/:groupID`
|
||||
|
||||
**Required permissions**
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------ | ----- |
|
||||
| groupsync.mappings:write | n/a |
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
DELETE /api/groupsync/groups/my_group_id HTTP/1.1
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt
|
||||
```
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **204** - Ok
|
||||
- **400** - Bad request
|
||||
- **401** - Unauthorized
|
||||
- **403** - Permission denied
|
||||
- **500** - Internal server error
|
||||
Loading…
Reference in New Issue
Block a user