API SIEM
La API SIEM expone los eventos de auditoría de Workspace como una fuente JSON paginada, compatible con el estándar Common Event Format (CEF). Utilícela para introducir registros de auditoría de Altium 365 en su sistema de información de seguridad y gestión de eventos (SIEM) o en cualquier herramienta de cumplimiento externa.
Cómo encontrar su punto final y sus credenciales
Cada espacio de trabajo tiene su propia URL de punto final de auditoría y sus propias credenciales. Para encontrarlas:
-
Vaya a
Admin → Settings → Audit Export en su espacio de trabajo. -
Copie el icono
Endpoint URL ,Client ID ySecret Key .
Puede regenerar o revocar la Clave Secreta desde esta página en cualquier momento. La regeneración de una clave invalida inmediatamente la anterior.
Autenticación
Cada solicitud requiere dos cabeceras personalizadas:
|
Su ID de cliente del espacio de trabajo |
|
Su clave secreta del espacio de trabajo |
Obtención de eventos
GET {su-punto-final-de-auditoría}?Offset=0&Limit=500
ClientId: {su-id-de-cliente}
ClientSecret: {su clave secreta}
Parámetros de consulta
Parámetro |
Obligatorio |
Descripción |
|
No |
Posición inicial en el conjunto de resultados. Por defecto: |
|
No |
Número máximo de eventos a devolver. No puede superar el máximo de la API; si se supera, se devuelve |
Ejemplo de Curl
curl -G '{su-punto-final-de-auditoría}' \
-H 'ClientId: {su-id-cliente}' \
-H 'ClientSecret: {su-clave-secreta}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Formato de la respuesta
{
"TotalCount" 2,
"Eventos": [
{
"CefVersion": "1",
"DeviceVendor": "Altium",
"DeviceProduct": "365 Platform",
"DeviceVersion": "Cloud",
"DeviceEventClassId": "",
"Name": "User Login",
"Extension": {
"dvchost": "host.dominio.com",
"msg": "Usuario ha iniciado sesión con éxito",
"rt": "2024-01-10T14:30:00Z",
"dtz": "UTC+00:00",
"suser": "sampleuser",
"act": "login",
"externalId": "45678",
"cat": "authentication"
}
}
]
}
Campos de nivel superior
Campo |
Tipo |
Descripción |
|
entero |
Número total de eventos disponibles en todas las páginas |
|
matriz |
Eventos en la página actual |
Campos de evento
Campo |
Tipo |
Descripción |
|
cadena |
Versión CEF |
|
cadena |
Siempre |
|
cadena |
Siempre |
|
cadena |
Siempre |
|
cadena |
Identificador de clase de evento |
|
cadena |
Nombre del evento legible por humanos (p. ej. |
|
objeto |
Datos detallados del acontecimiento - véase más abajo |
Campos de extensión
Campo |
Tipo |
Descripción |
|
cadena |
Nombre de dominio completo del espacio de trabajo |
|
cadena |
Descripción legible del evento |
|
cadena |
Marca de tiempo del evento (ISO 8601) |
|
cadena |
Zona horaria (por ejemplo |
|
cadena |
Nombre de usuario asociado al evento |
|
cadena |
Acción realizada (por ejemplo |
|
cadena |
ID de la entidad de origen |
|
cadena |
Categoría del evento (por ej. |
Paginación
Utilice TotalCountOffsetLimit
Página 1: Offset=0, Límite=500 → eventos 1-500 Página 2: Offset=500, Límite=500 → eventos 501-1000 ...
Códigos de estado HTTP
Código |
Significado |
|
Eventos devueltos correctamente |
|
|
|
Credenciales no válidas o licencia Enterprise no activa |
Lecturas Adicionales
Exportación de Auditoría en Altium 365 - Instalación y configuración del administrador del espacio de trabajo.