mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 01:42:07 +08:00
13cf67de53
* manually replce all shared relrefs * relref replace - grafana next * Merge branch 'master' into robbymilo/relref-replace-grafana-next * manual fixes * remove ref shortcode * Merge branch 'master' into robbymilo/relref-replace-grafana-next * prettier * fix test * update readme
343 lines
8.9 KiB
Markdown
343 lines
8.9 KiB
Markdown
---
|
|
aliases:
|
|
- ../../http_api/datasource_permissions/
|
|
- ../../http_api/datasourcepermissions/
|
|
canonical: /docs/grafana/latest/developers/http_api/datasource_permissions/
|
|
description: Data Source Permissions API
|
|
keywords:
|
|
- grafana
|
|
- http
|
|
- documentation
|
|
- api
|
|
- datasource
|
|
- permission
|
|
- permissions
|
|
- acl
|
|
- enterprise
|
|
labels:
|
|
products:
|
|
- enterprise
|
|
- oss
|
|
title: Datasource Permissions HTTP API
|
|
---
|
|
|
|
# Data Source Permissions API
|
|
|
|
> The Data Source Permissions 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.
|
|
|
|
This API can be used to list, add and remove permissions for a data source.
|
|
|
|
Permissions can be set for a user, team, service account or a basic role (Admin, Editor, Viewer).
|
|
|
|
## Get permissions for a data source
|
|
|
|
`GET /api/access-control/datasources/:uid`
|
|
|
|
Gets all existing permissions for the data source with the given `uid`.
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#data-source-permissions-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ---------------------------- | ------------------------------------------------------------------------------------------ |
|
|
| datasources.permissions:read | datasources:\*<br>datasources:uid:\*<br>datasources:uid:my_datasource (single data source) |
|
|
|
|
### Examples
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
GET /api/access-control/datasources/my_datasource HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 551
|
|
|
|
```
|
|
|
|
Status codes:
|
|
|
|
- **200** - Ok
|
|
- **401** - Unauthorized
|
|
- **403** - Access denied
|
|
- **500** - Internal error
|
|
|
|
## Add or revoke access to a data source for a user
|
|
|
|
`POST /api/access-control/datasources/:uid/users/:id`
|
|
|
|
Sets user permission for the data source with the given `uid`.
|
|
|
|
To add a permission, set the `permission` field to either `Query`, `Edit`, or `Admin`.
|
|
To remove a permission, set the `permission` field to an empty string.
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#data-source-permissions-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ----------------------------- | ------------------------------------------------------------------------------------------ |
|
|
| datasources.permissions:write | datasources:\*<br>datasources:uid:\*<br>datasources:uid:my_datasource (single data source) |
|
|
|
|
### Examples
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/users/1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "Query",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/users/1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
Status codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Permission cannot be added, see response body for details
|
|
- **401** - Unauthorized
|
|
- **403** - Access denied
|
|
|
|
## Add or revoke access to a data source for a team
|
|
|
|
`POST /api/access-control/datasources/:uid/teams/:id`
|
|
|
|
Sets team permission for the data source with the given `uid`.
|
|
|
|
To add a permission, set the `permission` field to either `Query`, `Edit`, or `Admin`.
|
|
To remove a permission, set the `permission` field to an empty string.
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#data-source-permissions-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ----------------------------- | ------------------------------------------------------------------------------------------ |
|
|
| datasources.permissions:write | datasources:\*<br>datasources:uid:\*<br>datasources:uid:my_datasource (single data source) |
|
|
|
|
### Examples
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/teams/1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "Edit",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/teams/1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
Status codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Permission cannot be added, see response body for details
|
|
- **401** - Unauthorized
|
|
- **403** - Access denied
|
|
|
|
## Add or revoke access to a data source for a basic role
|
|
|
|
`POST /api/access-control/datasources/:uid/builtInRoles/:builtinRoleName`
|
|
|
|
Sets permission for the data source with the given `uid` to all users who have the specified basic role.
|
|
|
|
You can set permissions for the following basic roles: `Admin`, `Editor`, `Viewer`.
|
|
|
|
To add a permission, set the `permission` field to either `Query`, `Edit`, or `Admin`.
|
|
To remove a permission, set the `permission` field to an empty string.
|
|
|
|
**Required permissions**
|
|
|
|
See note in the [introduction](#data-source-permissions-api) for an explanation.
|
|
|
|
| Action | Scope |
|
|
| ----------------------------- | ------------------------------------------------------------------------------------------ |
|
|
| datasources.permissions:write | datasources:\*<br>datasources:uid:\*<br>datasources:uid:my_datasource (single data source) |
|
|
|
|
### Examples
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/builtInRoles/Admin
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "Edit",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
**Example request:**
|
|
|
|
```http
|
|
POST /api/access-control/datasources/my_datasource/builtInRoles/Viewer
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
{
|
|
"permission": "",
|
|
}
|
|
```
|
|
|
|
**Example response:**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 35
|
|
|
|
```
|
|
|
|
Status codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Permission cannot be added, see response body for details
|
|
- **401** - Unauthorized
|
|
- **403** - Access denied
|