菜单
文档breadcrumb arrow Grafana 文档breadcrumb arrow 开发者breadcrumb arrow HTTP APIbreadcrumb arrow 仪表盘权限 HTTP API
Enterprise Open source

仪表盘权限 API

此 API 可用于更新/获取仪表盘的权限。

dashboardId=-1 的权限是具有 Viewer 和 Editor 角色的用户的默认权限。权限可以为用户、团队或角色（Viewer 或 Editor）设置。不能为管理员设置权限 - 他们始终拥有所有访问权限。

权限字段的权限级别

  • 1 = 查看
  • 2 = 编辑
  • 4 = 管理员

如果您正在运行 Grafana Enterprise，某些端点需要特定的权限。请参阅基于角色的访问控制权限获取更多信息。

获取仪表盘权限

GET /api/dashboards/uid/:uid/permissions

获取具有给定 uid 的仪表盘的所有现有权限。

所需权限

请参阅简介中的说明。

操作范围
dashboards.permissions:read
  • dashboards:*
  • dashboards:uid:*
  • folders:*
  • folders:uid:*

请求示例:

http 
GET /api/dashboards/uid/dHEquNzGz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例

http 
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 551

[
  {
    "id": 1,
    "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": "Viewer",
    "permission": 1,
    "permissionName": "View",
    "uid": "dHEquNzGz",
    "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": "dHEquNzGz",
    "title": "",
    "slug": "",
    "isFolder": false,
    "url": ""
  }
]

状态码

  • 200 - 成功
  • 401 - 未经授权
  • 403 - 拒绝访问
  • 404 - 仪表盘未找到

更新仪表盘权限

POST /api/dashboards/uid/:uid/permissions

更新仪表盘权限。如果请求中未包含现有权限，此操作将移除它们。

所需权限

请参阅简介中的说明。

操作范围
dashboards.permissions:write
  • dashboards:*
  • dashboards:uid:*
  • folders:*
  • folders:uid:*

请求示例:

http 
POST /api/dashboards/uid/dHEquNzGz/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 请求体模式

  • items - 要添加/更新的权限项。列表中省略的项将被移除。

响应示例:

http 
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message":"Dashboard permissions updated"}

状态码

  • 200 - 成功
  • 401 - 未经授权
  • 403 - 拒绝访问
  • 404 - 仪表盘未找到