Los Registros de Auditoría de Apidog registran la actividad relacionada con la seguridad a nivel de organización. Los Propietarios y Administradores de la organización pueden usarlos para identificar quién realizó una acción, cuándo ocurrió, la dirección IP de origen y el recurso de la organización afectado.
Este tutorial cubre el filtrado, la investigación, la exportación CSV y la recopilación basada en API. Estos registros son registros de auditoría administrativos; no son registros de solicitudes de API de producción ni registros de acceso de pasarela.
Antes de empezar
- Los Registros de Auditoría están disponibles en el plan Enterprise SaaS.
- Actualmente no están disponibles en Apidog On-Premises.
- Solo los Propietarios de la organización y los Administradores de la organización pueden verlos, exportarlos o consultarlos.
- Los datos del registro de auditoría se conservan durante 180 días.
Si su investigación puede extenderse más allá de los 180 días, exporte o recopile los registros requeridos antes de que expiren.
Paso 1: Abrir Registros de Auditoría
Abra su organización de Apidog y vaya a Registros de Auditoría en la configuración de la organización.
La tabla incluye:
- actor
- evento
- descripción
- dirección IP
- hora
Los Registros de Auditoría proporcionan registros a nivel de organización para eventos de seguridad y administración soportados.
Los eventos de autenticación aparecen solo cuando Apidog puede atribuirlos de forma fiable a la organización.
Paso 2: Definir la ventana de investigación
Comience con una pregunta específica, como:
- ¿Quién cambió el rol de un miembro de la organización?
- ¿Cuándo se rotó o revocó un token de acceso?
- ¿Qué cuenta cambió la configuración de SSO?
- ¿Quién cambió la configuración de acceso de un Sitio de Documentos o de un documento compartido?
- ¿Se aprovisionó o eliminó un usuario a través de SCIM?
Utilice el rango de tiempo más estrecho posible. Los preajustes disponibles incluyen los últimos 7, 30, 90 y 180 días. También puede seleccionar un rango personalizado dentro del período de retención de 180 días.
Registre la zona horaria utilizada por su proceso de incidente o auditoría antes de comparar estos eventos con los registros del proveedor de identidad, de tickets, de Git o de servicios.
Paso 3: Aplicar filtros
Filtre la tabla por:
- Rango de tiempo - cuándo pudo haber ocurrido el evento.
- Evento - la acción relevante, como un cambio de rol, un fallo de inicio de sesión, un cambio de token de acceso o una exportación de registro de auditoría.
- Actor - el usuario o la integración que realizó la acción.
Combine los filtros de tiempo, evento y actor para aislar los registros requeridos para una investigación.
Si no conoce al actor, comience con el tiempo y el evento. Si el nombre del evento es incierto, comience con el actor y un rango de tiempo corto.
Paso 4: Revisar los detalles del evento
Para cada fila relevante, capture:
- la hora del evento
- el actor o la integración
- la acción y la descripción
- la dirección IP de origen
- el miembro, equipo, configuración o recurso afectado
Luego correlacione el evento con la fuente que pueda responder la siguiente pregunta:
| Pregunta | Evidencia adicional |
|---|---|
| ¿Se aprobó la acción? | Solicitud de cambio, revisión de acceso o ticket |
| ¿Se esperaba el inicio de sesión? | Registros de inicio de sesión del proveedor de identidad y del dispositivo |
| ¿Qué tráfico de API siguió? | Registros de acceso de la pasarela, aplicación o API |
| ¿Qué contenido cambió? | Historial de recursos, diferencia de especificación o historial de Git |
| ¿Se utilizó una credencial? | Registros del sistema que emitió la credencial |
Un evento de auditoría muestra que ocurrió una acción soportada. Por sí mismo, no prueba que la acción estuviera autorizada, fuera segura o cumpliera con las normativas.
Paso 5: Exportar los resultados filtrados a CSV
Una vez que los filtros sean correctos:
- revise el conjunto de resultados visible
- seleccione la opción de exportación CSV
- guarde el archivo en la ubicación de investigación o auditoría aprobada
- registre la hora de exportación, los criterios de filtro y la persona que maneja el archivo
La exportación CSV utiliza los filtros aplicados actualmente a la página de Registros de Auditoría e incluye los registros coincidentes dentro del período de retención de 180 días.
La exportación de Registros de Auditoría se registra en los Registros de Auditoría. El CSV resultante es una copia separada, por lo que debe protegerlo con los controles de acceso, retención e integridad adecuados.
Paso 6: Recopilar Registros de Auditoría con la API
Las organizaciones empresariales pueden consultar registros programáticamente a través de la API de Registros de Auditoría. La API soporta consultas por ventana de tiempo y paginación por cursor dentro del período de retención de 180 días.
Para un proceso de recopilación programado:
- elija un intervalo de recopilación más corto que la ventana de retención
- consulte una hora de inicio y fin definida
- siga la paginación por cursor hasta que el conjunto de resultados esté completo
- guarde el punto de control de la recopilación
- reintente las ventanas fallidas sin crear lagunas silenciosas
- proteja el destino de acuerdo con su sensibilidad y política de retención
Cada consulta de API se registra como un resumen que puede incluir el llamador, la dirección IP, la ventana de consulta, el límite, el resultado y la marca de tiempo. La carga útil completa devuelta no se copia en los metadatos de ese evento.
Valide la referencia actual de la API antes de implementar la autenticación, las rutas de los puntos finales, los parámetros de solicitud o el análisis de la respuesta. No copie un ejemplo de código no verificado en un recolector de producción.
Verificar el registro de la investigación
Antes de cerrar una investigación, confirme que ha:
- guardado el rango de tiempo exacto y los filtros utilizados
- capturado todas las páginas de resultados relevantes
- preservado la respuesta CSV o API original en una ubicación aprobada
- correlacionado acciones importantes con evidencia de identidad, gestión de cambios y tiempo de ejecución
- documentado cualquier laguna causada por la retención, la atribución o tipos de eventos no soportados
Para los cambios de acceso, verifique también el estado actual. Un registro puede mostrar que un rol cambió, pero la página del miembro muestra qué rol está asignado ahora.
Manejo de datos sensibles
Apidog aplica la misma política de redacción a la página de Registros de Auditoría, las exportaciones CSV y las respuestas de la API. Los registros de auditoría no exponen valores de token, contraseñas, valores secretos, aserciones SAML sin procesar, tokens de restablecimiento, claves privadas o contenido de archivos exportados.
Los metadatos aún pueden ser sensibles. Restrinja el acceso a los registros exportados y evite colocarlos en tickets públicos o documentos compartidos.
Solución de problemas
| Problema | Qué revisar |
|---|---|
| La página de Registros de Auditoría no está disponible | Confirme que la organización utiliza Enterprise SaaS y que el visor es un Propietario o Administrador de la organización. |
| Falta un evento de autenticación esperado | Los eventos de autenticación aparecen solo cuando Apidog puede atribuirlos de forma fiable a la organización. Verifique también el proveedor de identidad. |
| El CSV contiene menos registros de lo esperado | Revise los filtros activos de tiempo, evento y actor. La exportación utiliza los filtros actuales. |
| Un recolector de API omite registros | Revise la ventana de consulta, el manejo del cursor, los reintentos y el límite de 180 días. |
| Faltan llamadas a la API en tiempo de ejecución | Utilice registros de acceso de pasarela, aplicación o API. Los Registros de Auditoría de Apidog son registros administrativos de la organización. |
Limitaciones importantes
Los Registros de Auditoría no proporcionan registros de solicitudes de producción, Historial de Recursos, reversión o recuperación completa a nivel de campo. Los conectores SIEM nativos, Syslog, el reenvío genérico de webhooks y la transmisión en tiempo real no están actualmente soportados. La recopilación programada de API es la opción documentada para enviar registros a una tubería de monitoreo o auditoría externa.
Tutoriales relacionados sobre gobernanza de API:
Estos tutoriales cubren controles complementarios para gobernar un espacio de trabajo de API empresarial:
- Marco de Gobernanza de API — conecta la propiedad, los controles, la evidencia y las decisiones del ciclo de vida.
- Mapeo de Grupos SAML con Microsoft Entra ID — asigna acceso de equipo desde grupos de proveedores de identidad.
- Escáner de Secretos — revisa posibles credenciales expuestas en los activos soportados de Apidog.
- Registros de Auditoría — investiga y exporta la actividad administrativa de la organización.
- Aprovisionamiento SCIM — gestiona usuarios de la organización a través del ciclo de vida de la identidad.
- Políticas Empresariales — configura controles de credenciales, membresía, sesiones SSO e invitaciones.
- Equipos de API de Autoservicio — permite equipos creados por miembros mientras se mantiene la supervisión de la propiedad.
- Integración con GitHub Enterprise Cloud — conecta repositorios GHE.com soportados para flujos de trabajo OpenAPI.
Documentación oficial relacionada: