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.

Enterprise license required. La opción Audit Export solo aparece en la configuración de Workspace Admin cuando hay activa una licencia de nivel Enterprise.

Cómo encontrar su endpoint y credenciales

Cada Workspace tiene su propia URL de endpoint de auditoría y sus propias credenciales. Para encontrarlas:

  1. Vaya a Admin → Settings → Audit Export en su Workspace.

  2. 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

ClientId

Su Workspace Client ID

ClientSecret

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

Offset

No

Posición inicial en el conjunto de resultados. Valor predeterminado: 0

Limit

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 400.

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

TotalCount

integer

Número total de eventos disponibles en todas las páginas

Events

array

Eventos de la página actual

Campos del evento

Campo

Tipo

Descripción

CefVersion

string

Versión de CEF

DeviceVendor

string

Siempre "Altium"

DeviceProduct

string

Siempre "365 Platform"

DeviceVersion

string

Siempre "Cloud"

DeviceEventClassId

string

Identificador de clase de evento

Name

string

Nombre del evento legible para humanos (p. ej. "User Login")

Extension

object

Datos detallados del evento – véase más abajo

Campos de extensión

Campo

Tipo

Descripción

dvchost

string

Nombre de dominio completo del Workspace

msg

string

Descripción del evento legible para humanos

rt

string

Marca de tiempo del evento (ISO 8601)

dtz

string

Zona horaria (p. ej. "UTC+00:00")

suser

string

Nombre de usuario asociado con el evento

act

string

Acción realizada (p. ej. "login", "create", "delete")

externalId

string

ID de la entidad de origen

cat

string

Categoría del evento (p. ej. "authentication", "design")

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

200 OK

Eventos devueltos correctamente

400 Bad Request

Limit supera el máximo de la API

401 Unauthorized

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.

 

AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Contenido