View a markdown version of this page

API de autenticación - Amazon Managed Grafana
Obtención de claves de la APICreación de una clave de la APIEliminación de una clave de la API

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de autenticación

Use la API de autenticación para trabajar con las claves de autenticación en un espacio de trabajo de Amazon Managed Grafana.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de cuenta de servicio válido. Lo incluye en el campo Authorization de la solicitud de API.

Obtención de claves de la 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: (opcional) parámetro booleano 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"}
]

Creación de una clave de la 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 JSON:

  • name: nombre de la clave.

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

  • segundos ToLive: establece el tiempo que debe transcurrir antes de que caduque la clave. Debe ser 2 592 000 (30 días) o menos.

Ejemplo de respuesta

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

Estados de error:

  • 400: secondsToLive es superior a 2 592 000.

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

Eliminación de una clave de la 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"}