

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Dashboard Permissions API
<a name="Grafana-API-DashboardPermissions"></a>

使用 Dashboard Permissions API 更新或擷取儀表板的許可。

具有 的許可`dashboardId=-1`是具有檢視器和編輯器角色之使用者的預設許可。您可以為使用者、團隊或角色 （檢視者或編輯器） 設定許可。無法為管理員設定許可 - 他們永遠可以存取所有項目。

`permission` 欄位的許可層級如下所示：
+ 1 = 檢視
+ 2 = 編輯
+ 4 = 管理員

**注意**  
若要搭配 Amazon Managed Grafana 工作區使用 Grafana API，您必須擁有有效的 Grafana API 字符。您可以在 API 請求的 `Authorization` 欄位中包含此項目。如需如何建立權杖以驗證 API 呼叫的詳細資訊，請參閱 [使用字符進行驗證](authenticating-grafana-apis.md)。

## 取得儀表板的許可
<a name="Grafana-API-DashboardPermissions-get"></a>

```
GET /api/dashboards/id/:dashboardId/permissions
```

使用指定的 取得儀表板的所有現有許可`dashboardId`。

**範例請求**

```
GET /api/dashboards/id/1/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,
    "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": "",
    "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** — OK
+ **401** — 未授權
+ **403** — 存取遭拒
+ **404** — 找不到儀表板

## 更新儀表板的許可
<a name="Grafana-API-DashboardPermissions-update"></a>

```
POST /api/dashboards/id/:dashboardId/permissions
```

更新儀表板的許可。如果請求中未包含現有許可，此操作會移除這些許可。

**範例請求**

```
POST /api/dashboards/id/1/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 內文結構描述：
+ **項目** — 要新增或更新的許可項目。從清單中省略的現有項目會被移除。

**回應範例**

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

{"message":"Dashboard permissions updated"}
```

狀態碼：
+ **200** — 已建立
+ **401** — 未授權
+ **403** — 存取遭拒
+ **404** — 找不到儀表板