API für Ordnerberechtigungen

Verwenden Sie die Folder-API, um die Berechtigungen für einen Ordner zu aktualisieren oder abzurufen.

Berechtigungen mit folderId=-1 sind die Standardberechtigungen für Benutzer mit den Rollen Viewer und Editor. Berechtigungen können für einen Benutzer, ein Team oder eine Rolle (Viewer oder Editor) festgelegt werden. Für Administratoren können keine Berechtigungen festgelegt werden — sie haben immer Zugriff auf alles.

Die Berechtigungsstufen für das permission Feld lauten wie folgt:

• 1 = Ansicht

• 2 = Bearbeiten

• 4 = Administrator

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Grafana-API-Token. Sie fügen dies in das Authorization Feld in der API-Anfrage ein. Informationen zum Erstellen eines Tokens zur Authentifizierung Ihrer API-Aufrufe finden Sie unterAuthentifizieren Sie sich mit Tokens.

Holen Sie sich Berechtigungen für einen Ordner

GET /api/folders/:uid/permissions

Ruft alle vorhandenen Berechtigungen für den Ordner mit den angegebenen abuid.

Beispielanforderung

GET /api/folders/nErXDvCkzz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

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": ""
  }
]

Statuscodes:

• 200 — Okay

• 401 — Nicht autorisiert

• 403 — Zugriff verweigert

• 404 — Ordner nicht gefunden

Aktualisieren Sie die Berechtigungen für einen Ordner

POST /api/folders/:uid/permissions

Aktualisiert die Berechtigungen für einen Ordner. Durch diesen Vorgang werden vorhandene Berechtigungen entfernt, wenn sie nicht in der Anforderung enthalten sind.

Beispielanforderung

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-Textschema:

• Elemente — Die Berechtigungselemente, die hinzugefügt oder aktualisiert werden sollen. Bestehende Elemente, die nicht in der Liste aufgeführt sind, werden entfernt.

Beispielantwort

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

{"message":"Folder permissions updated","id":1,"title":"Department ABC"}

Statuscodes:

• 200 — Erstellt

• 401 — Nicht autorisiert

• 403 — Zugriff verweigert

• 404 — Dashboard nicht gefunden