文件夹权限 API - Amazon Managed Grafana

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

文件夹权限 API

使用文件夹 API 更新或检索文件夹的权限。

权限folderId=-1是具有 “查看者” 和 “编辑” 角色的用户的默认权限。可以为用户、团队或角色(查看者或编辑)设置权限。无法为管理员设置权限,他们始终可以访问所有内容。

permission字段的权限级别如下:

  • 1 = 查看

  • 2 = 编辑

  • 4 = 管理员

注意

要在亚马逊托管 Grafana 工作空间中使用 Grafana API,您必须拥有有效的 Grafana API 令牌。您可以将其包含在 API 请求的Authorization字段中。有关如何创建令牌来验证您的 API 调用的信息,请参阅使用令牌进行身份验证

获取文件夹的权限

GET /api/folders/:uid/permissions

使用给定权限获取该文件夹的所有现有权限uid

示例请求

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

更新文件夹的权限。如果请求中未包含现有权限,则此操作会移除这些权限。

示例请求

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 正文架构:

  • item s — 要添加或更新的权限项目。从列表中省略的现有项目将被删除。

响应示例

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-找不到控制面板