Authentifizierungs-API

Verwenden Sie die Authentifizierungs-API, um mit Authentifizierungsschlüsseln in einem Amazon Managed Grafana-Arbeitsbereich 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.

Holen Sie sich API-Schlüssel

GET /api/auth/keys

Beispielanforderung

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

Abfrageparameter:

• includeExpired — (optional) Boolescher Parameter, der angibt, ob abgelaufene Schlüssel in die zurückgegebenen Ergebnisse aufgenommen werden sollen. Der Standardwert ist false.

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {"id": 3,"name": "API","role": "Admin"},
  {"id": 1,"name": "TestAdmin","role": "Admin","expiration": "2019-06-26T10:52:03+03:00"}
]

API-Schlüssel erstellen

POST /api/auth/keys

Beispielanforderung

POST /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "name": "mykey",
  "role": "Admin",
  "secondsToLive": 86400
}

JSON-Textschema:

• name — Der Name für den Schlüssel.

• Rolle — Legt die Zugriffsebene (Grafana-Rolle) für den Schlüssel fest. Gültige Werte sind Admin, Editor oder Viewer.

• secondsToLive— Legt die Zeitspanne fest, bis der Schlüssel abläuft. Es muss 2592000 (30 Tage) oder weniger sein.

Beispielantwort

{"name":"mykey","key":"eyJrIjoiWHZiSWd3NzdCYUZnNUtibE9obUpESmE3bzJYNDRIc0UiLCJuIjoibXlrZXkiLCJpZCI6MX1=","id":1}

Fehlerstatus:

• 400 — secondsToLive ist größer als 2592000

• 500 — Der Schlüssel konnte nicht in der Datenbank gespeichert werden.

API-Schlüssel löschen

DELETE /api/auth/keys/:id

Beispielanforderung

DELETE /api/auth/keys/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{"message":"API key deleted"}