Saltearse al contenido
GERION
ES EN

API Keys

Las API Keys son las credenciales de larga duración que usa la CLI y los pipelines de CI/CD para autenticarse con Gerion. Se gestionan desde el dashboard — no existe un endpoint público para crearlas o revocarlas.

Crear una API Key

  1. Inicia sesión en el dashboard en https://app.gerion.dev.
  2. Ve a Settings → API Keys.
  3. Haz clic en Create New Key.
  4. Rellena los campos:
    • Name: nombre descriptivo (p.ej. jenkins-prod).
    • Client ID: identificador único del cliente, 3–50 caracteres alfanuméricos con ., -, _. Debe ser único en tu organización y coincidir con el client_id que uses al llamar al endpoint de autenticación.
    • Permissions: selecciona los permisos necesarios (ver tabla abajo).
    • Expires at: fecha de expiración opcional. Recomendado para credenciales de CI/CD.
  5. Copia la API Key generada. No podrás volver a verla.

Permisos disponibles

PermisoDescripción
write:findingsSubir hallazgos de seguridad (POST /api/v1/findings). Requerido para la CLI.
read:findingsConsultar hallazgos (acceso interno vía dashboard).

Para el uso estándar de la CLI, el permiso mínimo necesario es write:findings.

Uso en CI/CD

Una vez creada, configura la clave como secreto en tu pipeline y referéncialas como variables de entorno:

Ventana de terminal
# Variables requeridas por la CLI
GERION_API_URL=https://api.gerion.dev
GERION_API_KEY=<tu-api-key>
GERION_CLIENT_ID=<tu-client-id>

Consulta la sección de Guías de CI/CD para ejemplos específicos de cada plataforma.

Revocar o eliminar una API Key

Desde el dashboard, en Settings → API Keys, puedes:

  • Revocar: deshabilita la clave inmediatamente sin eliminarla (auditable).
  • Eliminar: elimina la clave de forma permanente.

Cualquier token JWT generado con una clave revocada o eliminada dejará de ser válido en la siguiente verificación.

Rotación recomendada

  • CI/CD de producción: rota cada 90 días. Usa la fecha de expiración para forzarlo.
  • Runners de desarrollo: sin expiración es aceptable si el entorno está aislado.
  • Ante una filtración, revoca inmediatamente desde el dashboard y crea una nueva clave.