mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
docs: dashboard and folder permissions http api
This commit is contained in:
@@ -11,7 +11,7 @@ parent = "http_api"
|
|||||||
|
|
||||||
# Dashboard Permissions API
|
# Dashboard Permissions API
|
||||||
|
|
||||||
This API can be used to update/get the permissions for a dashboard or a folder.
|
This API can be used to update/get the permissions for a dashboard.
|
||||||
|
|
||||||
Permissions with `dashboardId=-1` are the default permissions for users with the Viewer and Editor roles. Permissions can be set for a user, a team or a role (Viewer or Editor). Permissions cannot be set for Admins - they always have access to everything.
|
Permissions with `dashboardId=-1` are the default permissions for users with the Viewer and Editor roles. Permissions can be set for a user, a team or a role (Viewer or Editor). Permissions cannot be set for Admins - they always have access to everything.
|
||||||
|
|
||||||
@@ -21,16 +21,16 @@ The permission levels for the permission field:
|
|||||||
- 2 = Edit
|
- 2 = Edit
|
||||||
- 4 = Admin
|
- 4 = Admin
|
||||||
|
|
||||||
## Get permissions for a dashboard or folder
|
## Get permissions for a dashboard
|
||||||
|
|
||||||
`GET /api/dashboards/id/:dashboardId/acl`
|
`GET /api/dashboards/id/:dashboardId/permissions`
|
||||||
|
|
||||||
Gets all existing permissions for the dashboard or folder with the given `dashboardId`.
|
Gets all existing permissions for the dashboard with the given `dashboardId`.
|
||||||
|
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|
||||||
```http
|
```http
|
||||||
GET /api/dashboards/id/1/acl HTTP/1.1
|
GET /api/dashboards/id/1/permissions HTTP/1.1
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||||
@@ -90,18 +90,18 @@ Status Codes:
|
|||||||
JSON body schema:
|
JSON body schema:
|
||||||
|
|
||||||
- **items** - The permission items to add/update. Items that are omitted from the list will be removed.
|
- **items** - The permission items to add/update. Items that are omitted from the list will be removed.
|
||||||
|
|
||||||
**Example response**:
|
**Example response**:
|
||||||
|
|
||||||
```http
|
```http
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
Content-Type: application/json; charset=UTF-8
|
Content-Type: application/json; charset=UTF-8
|
||||||
Content-Length: 35
|
Content-Length: 35
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Status Codes:
|
Status Codes:
|
||||||
|
|
||||||
- **200** - Ok
|
- **200** - Ok
|
||||||
- **401** - Unauthorized
|
- **401** - Unauthorized
|
||||||
- **403** - Access denied
|
- **403** - Access denied
|
||||||
@@ -138,7 +138,7 @@ HTTP/1.1 200 OK
|
|||||||
Content-Type: application/json; charset=UTF-8
|
Content-Type: application/json; charset=UTF-8
|
||||||
Content-Length: 35
|
Content-Length: 35
|
||||||
|
|
||||||
{"message":"Dashboard acl updated"}
|
{"message":"Dashboard permissions updated"}
|
||||||
```
|
```
|
||||||
|
|
||||||
Status Codes:
|
Status Codes:
|
||||||
|
149
docs/sources/http_api/folder_permissions.md
Normal file
149
docs/sources/http_api/folder_permissions.md
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
+++
|
||||||
|
title = "Folder Permissions HTTP API "
|
||||||
|
description = "Grafana Folder Permissions HTTP API"
|
||||||
|
keywords = ["grafana", "http", "documentation", "api", "folder", "permission", "permissions", "acl"]
|
||||||
|
aliases = ["/http_api/dashboardpermissions/"]
|
||||||
|
type = "docs"
|
||||||
|
[menu.docs]
|
||||||
|
name = "Folder Permissions"
|
||||||
|
parent = "http_api"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Folder Permissions API
|
||||||
|
|
||||||
|
This API can be used to update/get the permissions for a folder.
|
||||||
|
|
||||||
|
Permissions with `folderId=-1` are the default permissions for users with the Viewer and Editor roles. Permissions can be set for a user, a team or a role (Viewer or Editor). Permissions cannot be set for Admins - they always have access to everything.
|
||||||
|
|
||||||
|
The permission levels for the permission field:
|
||||||
|
|
||||||
|
- 1 = View
|
||||||
|
- 2 = Edit
|
||||||
|
- 4 = Admin
|
||||||
|
|
||||||
|
## Get permissions for a folder
|
||||||
|
|
||||||
|
`GET /api/folders/:uid/permissions`
|
||||||
|
|
||||||
|
Gets all existing permissions for the folder with the given `uid`.
|
||||||
|
|
||||||
|
**Example request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
GET /api/folders/nErXDvCkzz/permissions 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
|
||||||
|
- **404** - Folder not found
|
||||||
|
|
||||||
|
## Update permissions for a folder
|
||||||
|
|
||||||
|
`POST /api/folders/:uid/permissions`
|
||||||
|
|
||||||
|
Updates permissions for a folder. This operation will remove existing permissions if they're not included in the request.
|
||||||
|
|
||||||
|
**Example request**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
POST /api/folders/nErXDvCkzz/permissions
|
||||||
|
Accept: application/json
|
||||||
|
Content-Type: application/json
|
||||||
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||||
|
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"role": "Viewer",
|
||||||
|
"permission": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"role": "Editor",
|
||||||
|
"permission": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"teamId": 1,
|
||||||
|
"permission": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"userId": 11,
|
||||||
|
"permission": 4
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
JSON body schema:
|
||||||
|
|
||||||
|
- **items** - The permission items to add/update. Items that are omitted from the list will be removed.
|
||||||
|
|
||||||
|
**Example response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200 OK
|
||||||
|
Content-Type: application/json; charset=UTF-8
|
||||||
|
Content-Length: 35
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Status Codes:
|
||||||
|
|
||||||
|
- **200** - Ok
|
||||||
|
- **401** - Unauthorized
|
||||||
|
- **403** - Access denied
|
||||||
|
- **404** - Dashboard not found
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"role": "Viewer",
|
||||||
|
"permission": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"role": "Editor",
|
||||||
|
"permission": 2
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"teamId": 1,
|
||||||
|
"permission": 1
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"userId": 11,
|
||||||
|
"permission": 4
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
JSON body schema:
|
||||||
|
|
||||||
|
- **items** - The permission items to add/update. Items that are omitted from the list will be removed.
|
||||||
|
|
||||||
|
**Example response**:
|
||||||
|
|
||||||
|
```http
|
||||||
|
HTTP/1.1 200 OK
|
||||||
|
Content-Type: application/json; charset=UTF-8
|
||||||
|
Content-Length: 35
|
||||||
|
|
||||||
|
{"message":"Folder permissions updated"}
|
||||||
|
```
|
||||||
|
|
||||||
|
Status Codes:
|
||||||
|
|
||||||
|
- **200** - Ok
|
||||||
|
- **401** - Unauthorized
|
||||||
|
- **403** - Access denied
|
||||||
|
- **404** - Dashboard not found
|
Reference in New Issue
Block a user