文件夹权限 API
此 API 可用于更新/获取文件夹的权限。
folderId=-1
的权限是 Viewer 和 Editor 角色的默认权限。权限可以针对用户、团队或角色(Viewer 或 Editor)进行设置。管理员无法设置权限 - 他们始终拥有所有内容的访问权限。
权限字段的权限级别
- 1 = 查看
- 2 = 编辑
- 4 = 管理
如果您运行的是 Grafana Enterprise 版,对于某些端点,您需要拥有特定的权限。有关更多信息,请参阅基于角色的访问控制权限。
获取文件夹的权限
GET /api/folders/:uid/permissions
获取给定 uid
文件夹的所有现有权限。
所需权限
有关说明,请参阅简介中的注意事项。
操作 | 范围 |
---|---|
folders.permissions:read | folders:* |
请求示例:
GET /api/folders/nErXDvCkzz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 551
[
{
"id": 1,
"folderId": -1,
"created": "2017-06-20T02:00:00+02:00",
"updated": "2017-06-20T02:00:00+02:00",
"userId": 0,
"userLogin": "",
"userEmail": "",
"teamId": 0,
"team": "",
"role": "Viewer",
"permission": 1,
"permissionName": "View",
"uid": "nErXDvCkzz",
"title": "",
"slug": "",
"isFolder": false,
"url": ""
},
{
"id": 2,
"dashboardId": -1,
"created": "2017-06-20T02:00:00+02:00",
"updated": "2017-06-20T02:00:00+02:00",
"userId": 0,
"userLogin": "",
"userEmail": "",
"teamId": 0,
"team": "",
"role": "Editor",
"permission": 2,
"permissionName": "Edit",
"uid": "",
"title": "",
"slug": "",
"isFolder": false,
"url": ""
}
]
状态码
- 200 - 正常
- 401 - 未授权
- 403 - 访问被拒绝
- 404 - 未找到文件夹
更新文件夹的权限
POST /api/folders/:uid/permissions
更新文件夹的权限。此操作将移除请求中未包含的现有权限。
所需权限
有关说明,请参阅简介中的注意事项。
操作 | 范围 |
---|---|
folders.permissions:write | folders:* |
请求示例:
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 - 要添加/更新的权限项。列表中省略的项将被移除。
响应示例:
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35
{"message":"Folder permissions updated","id":1,"title":"Department ABC"}
状态码
- 200 - 正常
- 401 - 未授权
- 403 - 访问被拒绝
- 404 - 未找到仪表板