ダッシュボードアクセス許可 API - Amazon Managed Grafana
ダッシュボードのアクセス許可を取得するダッシュボードのアクセス許可を更新する

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ダッシュボードアクセス許可 API

Dashboard Permissions API を使用して、ダッシュボードのアクセス許可を更新または取得します。

を使用したアクセス許可dashboardId=-1は、ビューワーロールとエディタロールを持つユーザーのデフォルトのアクセス許可です。アクセス許可は、ユーザー、チーム、またはロール (ビューワーまたはエディタ) に設定できます。管理者にはアクセス許可を設定できません。管理者は常にすべてにアクセスできます。

permission フィールドのアクセス許可レベルは次のとおりです。

  • 1 = 表示

  • 2 = 編集

  • 4 = 管理者

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorizationフィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証。

ダッシュボードのアクセス許可を取得する

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 - ダッシュボードが見つかりません

ダッシュボードのアクセス許可を更新する

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 本文スキーマ：

  • items — 追加または更新するアクセス許可項目。リストから省略された既存の項目は削除されます。

レスポンスの例

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

{"message":"Dashboard permissions updated"}

ステータスコード：

  • 200 - 作成済み

  • 401 - 未承認

  • 403 - アクセス拒否

  • 404 - ダッシュボードが見つかりません