Organisations-API - Amazon Managed Grafana
Aktuelle Organisation abrufenRuft alle Benutzer innerhalb der aktuellen Organisation abRuft alle Benutzer innerhalb der aktuellen Organisation ab (Suche)Aktualisiert den angegebenen BenutzerLöscht den Benutzer in der aktuellen OrganisationAktualisieren Sie die aktuelle OrganisationBenutzer zur aktuellen Organisation hinzufügen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Organisations-API

Verwenden Sie die Organization API, um mit Organisationen in einem Amazon Managed Grafana-Workspace zu arbeiten.

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.

Aktuelle Organisation abrufen

GET /api/org/

Beispielanforderung

GET /api/org/ HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "name":"Main Org."
}

Ruft alle Benutzer innerhalb der aktuellen Organisation ab

GET /api/org/users

Erforderliche Berechtigungen: die org.users:read Aktion mit dem Geltungsbereich users:*

Beispielanforderung

GET /api/org/users HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "orgId": 1,
    "userId": 1,
    "email": "admin@localhost",
    "avatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae",
    "login": "admin",
    "role": "Admin",
    "lastSeenAt": "2019-08-09T11:02:49+02:00",
    "lastSeenAtAge": "< 1m"
  }
]

Ruft alle Benutzer innerhalb der aktuellen Organisation ab (Suche)

GET /api/org/users/lookup

Gibt alle Benutzer innerhalb der aktuellen Organisation zurück, jedoch mit weniger detaillierten Informationen. Zugänglich für Benutzer mit der Rolle eines Organisationsadministrators, eines Administrators in einem beliebigen Ordner oder eines Administrators eines beliebigen Teams. Wird hauptsächlich von der Grafana-Benutzeroberfläche verwendet, um beim Hinzufügen von Teammitgliedern und beim Bearbeiten von Ordner-/Dashboard-Berechtigungen eine Benutzerliste bereitzustellen.

Beispielanforderung

GET /api/org/users/lookup HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "userId": 1,
    "login": "admin",
    "avatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae"
  }
]

Aktualisiert den angegebenen Benutzer

PATCH /api/org/users/:userId

Erforderliche Berechtigungen: die org.users.role:update Aktion mit dem Geltungsbereich users:*

Beispielanforderung

PATCH /api/org/users/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "role": "Viewer",
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization user updated"}

Löscht den Benutzer in der aktuellen Organisation

DELETE /api/org/users/:userId

Erforderliche Berechtigungen: Die org.users:remove Aktion mit dem Geltungsbereich users:*

Beispielanforderung

DELETE /api/org/users/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"User removed from organization"}

Aktualisieren Sie die aktuelle Organisation

PUT /api/org

Beispielanforderung

PUT /api/org HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "name":"Main Org."
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"Organization updated"}

Benutzer zur aktuellen Organisation hinzufügen

POST /api/org/users

Erforderliche Berechtigungen: Die org.users:add Aktion mit dem Geltungsbereich users:*

Beispielanforderung

POST /api/org/users HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "role": "Admin",
  "loginOrEmail": "admin"
}

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"User added to organization","userId":1}