API di autenticazione - Grafana gestito da Amazon

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

API di autenticazione

Usa l'API di autenticazione per lavorare con le chiavi di autenticazione in uno spazio di lavoro Amazon Managed Grafana.

Nota

Per utilizzare un'API Grafana con il tuo spazio di lavoro Amazon Managed Grafana, devi disporre di un token API Grafana valido. Lo includi nel Authorization campo della richiesta API. Per informazioni su come creare un token per autenticare le chiamate API, consultaAutenticazione con token.

Ottieni le chiavi API

GET /api/auth/keys

Richiesta di esempio

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

Parametro di interrogazione:

  • includeExpired — (Facoltativo) parametro booleano che specifica se includere chiavi scadute nei risultati restituiti. Il valore predefinito è false.

Example response

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

Crea una chiave API

POST /api/auth/keys

Richiesta di esempio

POST /api/auth/keys HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "name": "mykey", "role": "Admin", "secondsToLive": 86400 }

Schema del corpo JSON:

  • name: il nome della chiave.

  • role — Imposta il livello di accesso (ruolo Grafana) per la chiave. I valori validi sono Admin, Editor o Viewer.

  • secondsToLive— Imposta la quantità di tempo prima della scadenza della chiave. Deve essere 2592000 (30 giorni) o meno.

Example response

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

Stati di errore:

  • 400: secondsToLive è maggiore di 2592000

  • 500 — La chiave non può essere archiviata nel database.

Elimina la chiave API

DELETE /api/auth/keys/:id

Richiesta di esempio

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

Example response

HTTP/1.1 200 Content-Type: application/json {"message":"API key deleted"}