API de autenticación

Usa la API de autenticación para trabajar con las claves de autenticación en un espacio de trabajo de Grafana gestionado por Amazon.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de API de Grafana válido. Lo incluyes en el Authorization campo de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar tus llamadas a la API, consultaAutenticarse con fichas.

Obtén las claves de API

GET /api/auth/keys

Ejemplo de solicitud

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

Parámetro de consulta:

• IncludeExpired: parámetro booleano (opcional) que especifica si se deben incluir las claves caducadas en los resultados devueltos. El valor predeterminado es false.

Ejemplo de respuesta

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 clave de API

POST /api/auth/keys

Ejemplo de solicitud

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

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

Esquema de cuerpo de JSON:

• nombre: el nombre de la clave.

• rol: establece el nivel de acceso (rol de Grafana) de la clave. Los valores válidos son Admin, Editor o Viewer.

• secondsToLive— Establece el tiempo que debe transcurrir antes de que caduque la clave. Debe ser de 2592000 (30 días) o menos.

Ejemplo de respuesta

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

Estados de error:

• 400: secondsToLive es superior a 2592000

• 500: no se pudo almacenar la clave en la base de datos.

Eliminar la clave de API

DELETE /api/auth/keys/:id

Ejemplo de solicitud

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

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

{"message":"API key deleted"}