Generación de claves API para la API de Cato

Hay páginas CMA separadas para los dos tipos de claves API.

Claves API - para uso personal de administradores individuales
Claves de Servicio - para uso compartido entre diferentes principales de servicio

Resumen

Cato te permite generar claves de API en la Aplicación de Gestión de Cato (CMA) que se utilizan para autenticar llamadas de API al servidor de API de Cato. Introduce la clave de API para un cliente de API, código, scripts, Terraform, integración SIEM, MCP, y más para interactuar de manera segura con los servicios de Cato.

Estos son los tipos de claves de API:

Claves API de Administrador son claves personales vinculadas a tu cuenta de administrador, que usas para tus propios flujos de trabajo de API. Solo puedes crear claves API de administrador para ti mismo. Para más información, consulte abajo Claves API de Administrador.
Claves API de Servicio son claves compartidas usadas por procesos de sistema, automatización o integraciones de terceros. Estas claves no están vinculadas a un inicio de sesión de administrador individual y son más apropiadas para casos de uso operativos. Para más información, consulte abajo Claves API del Principal de Servicio.

Cato proporciona soporte granular para dos niveles de llamadas de API:

Consultar APIs - Realiza llamadas de API de solo lectura para recuperar datos de tu cuenta

Los permisos de Viewer te permiten solo ejecutar llamadas de API de consulta. Esto se aplica ya sea que los permisos se asignen a través de un rol o se limiten a páginas específicas de CMA.
APIs de Configuración - Realiza llamadas de API de escritura para realizar cambios de configuración en tu cuenta

Los permisos de Editar te permiten solo ejecutar llamadas de API de configuración o consulta. Esto se aplica ya sea que los permisos se asignen a través de un rol o se limiten a páginas específicas de CMA.

Agregar claves API a un cliente API

Para autenticar solicitudes a la API de Cato, incluye un encabezado HTTP llamado x-api-key en tu cliente API. Establece el valor de este encabezado en tu clave de API de Cato usando el formato: x-api-key: <api-key>. Por ejemplo: x-api-key: abcdef12345. Este encabezado autoriza tu solicitud y otorga acceso a los endpoints de la API de Cato relevantes según los permisos asociados con tu clave.

Administradores de servicio principal

Un admin principal de servicio es un tipo especial de admin de CMA creado específicamente para flujos de trabajo basados en API. Para soportar de manera segura integraciones de sistema y procesos de automatización, crea admins principales de servicio para tu cuenta. Esto te permite generar claves de API que están desacopladas de las credenciales de inicio de sesión personal y no pueden usarse para acceder a la CMA.

Las credenciales de admin principal de servicio se utilizan exclusivamente para la autenticación de API con una clave de servicio de API correspondiente. Esta configuración mejora la seguridad y refuerza la separación de tareas para operaciones automatizadas.

Nota: Un nuevo administrador CMA con el nombre Servicio de automatización Principal (Editor) se crea automáticamente como parte de la adición de la clave API de servicio principal a cuentas existentes.

Para crear un admin principal de servicio:

En el menú de navegación, haz clic en Cuenta > Administradores.
Haz clic en Nuevo.

Se abre el panel de Crear Administrador.
Selecciona Crear Nuevo, y Crear como Principal de Servicio.
Introduce la configuración General para el admin.
Selecciona el Rol y cualquier sitio y usuario específico que definirá los permisos para este admin. Para aprender sobre roles, consulta Gestión de Roles de Admin Usando RBAC.

Estos permisos se aplicarán a la clave de API Principal de Servicio.
Haz clic en Aplicar. El admin se añade a la página de Administradores, y el admin principal de servicio se activa automáticamente.

Generando Claves API

Las páginas de Claves de API y Claves de API de Servicio te permiten generar y revocar claves de API. El Nombre de la clave API se utiliza solo para identificar cada clave y no se usa como parte del proceso de autenticación.

Para mayor seguridad, puedes restringir las IP de origen o el rango de IP (CIDR) para las claves API y de Servicio.

Nota: Asegúrate de copiar el valor de la clave de API desde la ventana emergente. Una vez que cierres la ventana emergente, no puedes acceder al valor de la clave de nuevo.

Claves API del administrador

Cuando necesites soportar tus propios flujos de trabajo de automatización como un admin individual, crea una clave de API de admin que esté vinculada a tus credenciales de admin de CMA. Solo puedes crear claves de API de admin para tu propio uso, no para otros admins, y solo a través de la CMA.

Cuando se elimina un admin, la clave de API asociada se desactiva automáticamente. Si un admin está deshabilitado, la clave está marcada como Deshabilitada, y las llamadas de API que la utilizan devolverán un error.

Permisos de RBAC para Claves de API de Admin

Cada clave de API de admin hereda los permisos de RBAC y roles del admin que la creó. Los permisos se actualizan dinámicamente si cambian los roles RBAC del admin, incluyendo permisos para sitios específicos, grupos de usuarios, grupos, etc...
Los admins con el rol de Viewer pueden ver toda la información de la clave de API (no el valor real de la clave)
Los admins con un rol RBAC de Editor que incluye la página de Claves de API pueden ver las claves de API en la cuenta y también revocarlas (eliminarlas)

Para generar una clave de API de admin:

En el menú de navegación, haz clic en Recursos > Claves API de Administrador.
Haz clic en Nuevo. Se abre el panel de Crear clave API.
Introduce un Nombre de Clave.
Para aplicar solo permisos de visualización para esta clave, selecciona Degradar a Ver.
(Opcional) Para mayor seguridad, en Permitir acceso desde IPs, selecciona Lista específica de IPs, y define las direcciones IP o el rango de IPs que están permitidos para usar esta clave API.

La configuración predeterminada es permitir esta clave API para Cualquier Dirección IP.
(Opcional) Selecciona una fecha en la que la clave API Expira en.

Para claves API con permisos de Edición, recomendamos establecer una fecha para que la clave API Expire en.
Haz clic en Aplicar. La clave de API se añade a la página, y se muestra una ventana emergente que contiene el valor de la nueva clave de API.
Haz clic en el botón para copiar la Clave de API que es generada por la CMA y guárdala en un lugar seguro.

Una vez que cierras esta ventana, no podrás acceder al valor de la clave API.
Haz clic en OK para cerrar la ventana emergente.

Claves API de Servicio Principal

Cuando necesites soportar flujos de trabajo operativos o de integración compartidos, crea una clave de API de servicio desde la página de Claves de API de Servicio. Estas claves están diseñadas para su uso por servicios de automatización y scripts que no requieren acceso a la CMA. Están conectados al administrador del servicio principal que creó la clave.

Las Claves de API de Servicio pueden utilizarse en sistemas y equipos, permitiendo una integración escalable con herramientas y servicios externos. Estos tipos de claves no están vinculados a un admin de CMA y están destinadas para operaciones de backend o pipelines de entrega continua.

Permisos de RBAC para Claves de API de Servicio

Solo los admins con el rol de Editor pueden crear o gestionar claves de API principal de servicio
Cada Clave de API de Servicio hereda los permisos de RBAC y roles del admin principal de servicio asociado con la clave. Si los permisos de RBAC para el admin cambian, entonces la clave de API principal de servicio se actualiza automáticamente con los nuevos permisos.

Para generar una clave API del servicio:

En el menú de navegación, haz clic en Recursos > Claves API del Servicio.
Haz clic en Nuevo. Se abre el panel Crear Clave API.
Selecciona el Servicio Principal asociado con esta clave.
Introduce un Nombre de la Clave.
Para aplicar solo permisos de visualización para esta clave, selecciona Degradar a Ver.
(Opcional) Para seguridad adicional, en Permitir acceso desde IPs, selecciona Lista específica de IPs, y define las direcciones IP o rango IP que están permitidas para usar esta clave API.

La configuración predeterminada es permitir esta clave API para Cualquier dirección IP.
(Opcional) Selecciona una fecha en la que la clave API Vence.

Para las claves API con permisos de Editar, recomendamos establecer una fecha en la que la clave API Vence.
Haz clic en Aplicar. La clave API se agrega a la página, y se muestra una ventana emergente que contiene el valor para la nueva clave API.
Haz clic en el botón para copiar la Clave API que genera el CMA y guárdala en una ubicación segura.

Una vez que cierres esta ventana, no puedes acceder al valor de la clave API.
Haz clic en OK para cerrar la ventana emergente.

Revocando una Clave API

Puedes revocar la clave de API y eliminarla de la CMA. Una vez revocada, la clave no se puede utilizar para autenticar en el servidor API.

Para revocar una clave API:

En el menú de navegación, haz clic en Recursos > Claves API de Administrador o Claves API del Servicio.
En la fila con la clave de API, haz clic en el icono de eliminar al final de la fila.
En la ventana de confirmación, haz clic en Eliminar. La clave API se revoca y se elimina de tu cuenta.