API de SIEM
La API de SIEM expone los eventos de auditoría del Workspace como un feed JSON paginado, compatible con el estándar Common Event Format (CEF). Úsela para ingerir los registros de auditoría de Altium 365 en su sistema de Security Information and Event Management (SIEM) o en cualquier herramienta externa de cumplimiento.
Cómo encontrar su endpoint y credenciales
Cada Workspace tiene su propia URL de endpoint de auditoría y sus propias credenciales. Para encontrarlas:
-
Vaya a Admin → Settings → Audit Export en su Workspace.
-
Copie el Endpoint URL, Client ID y Secret Key.
Puede regenerar o revocar la Secret Key desde esta página en cualquier momento. Al regenerar una clave, la anterior se invalida de inmediato.
Autenticación
Cada solicitud requiere dos encabezados personalizados:
Header |
Value |
|
Su Workspace Client ID |
|
Su Workspace Secret Key |
Obtención de eventos
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Parámetros de consulta
Parámetro |
Obligatorio |
Descripción |
|
No |
Posición inicial en el conjunto de resultados. Valor predeterminado: |
|
No |
Número máximo de eventos que se devolverán. No puede superar el máximo de la API; si se supera, se devuelve |
Ejemplo de curl
curl -G '{your-audit-endpoint}' \
-H 'ClientId: {your-client-id}' \
-H 'ClientSecret: {your-secret-key}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Formato de respuesta
{
"TotalCount": 2,
"Events": [
{
"CefVersion": "1",
"DeviceVendor": "Altium",
"DeviceProduct": "365 Platform",
"DeviceVersion": "Cloud",
"DeviceEventClassId": "",
"Name": "User Login",
"Extension": {
"dvchost": "host.domain.com",
"msg": "User successful login",
"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 |
|
integer |
Número total de eventos disponibles en todas las páginas |
|
array |
Eventos de la página actual |
Campos del evento
Campo |
Tipo |
Descripción |
|
string |
Versión de CEF |
|
string |
Siempre |
|
string |
Siempre |
|
string |
Siempre |
|
string |
Identificador de clase de evento |
|
string |
Nombre del evento legible para humanos (p. ej. |
|
object |
Datos detallados del evento – véase más abajo |
Campos de extensión
Campo |
Tipo |
Descripción |
|
string |
Nombre de dominio completo del Workspace |
|
string |
Descripción del evento legible para humanos |
|
string |
Marca de tiempo del evento (ISO 8601) |
|
string |
Zona horaria (p. ej. |
|
string |
Nombre de usuario asociado con el evento |
|
string |
Acción realizada (p. ej. |
|
string |
ID de la entidad de origen |
|
string |
Categoría del evento (p. ej. |
Paginación
Use TotalCount de la primera respuesta para determinar cuántas páginas se deben recuperar. Incremente Offset según su Limit en cada solicitud posterior hasta recuperar todos los eventos.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Códigos de estado HTTP
Código |
Significado |
|
Eventos devueltos correctamente |
|
|
|
Credenciales no válidas, o la licencia Enterprise no está activa |
Lecturas adicionales
Audit Export en Altium 365 – configuración y ajuste de Workspace admin.