API SIEM
L'API SIEM espone gli eventi di audit di Workspace come feed JSON paginato, compatibile con lo standard Common Event Format (CEF). Utilizzatela per ingerire i log di audit di Altium 365 nel vostro sistema SIEM (Security Information and Event Management) o in qualsiasi strumento di conformità esterno.
Trovare l'endpoint e le credenziali
Ogni Workspace ha un proprio URL e credenziali per l'endpoint di audit. Per trovarli:
-
Andare a
Admin → Settings → Audit Export nel vostro spazio di lavoro. -
Copiare il pulsante
Endpoint URL ,Client ID , eSecret Key .
È possibile rigenerare o revocare la chiave segreta da questa pagina in qualsiasi momento. La rigenerazione di una chiave invalida immediatamente quella precedente.
Autenticazione
Ogni richiesta richiede due intestazioni personalizzate:
|
L'ID del cliente dell'area di lavoro |
|
La chiave segreta dello spazio di lavoro |
Recuperare gli eventi
GET {il tuo endpoint di audit}?Offset=0&Limit=500
ClientId: {il tuo-client-id}
ClientSecret: {tua-chiave-segreta}
Parametri della query
Parametro |
Richiesto |
Descrizione |
|
No |
Posizione iniziale nel set di risultati. Predefinito: |
|
No |
Numero massimo di eventi da restituire. Non può superare il massimo dell'API; se lo supera, viene restituito |
Esempio di Curl
curl -G '{vostro-endpoint di audit}' \
-H 'ClientId: {vostro-client-id}' \
-H 'ClientSecret: {tua-chiave-segreta}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Formato della risposta
{
"TotalCount": 2,
"Events": [
{
"CefVersion": "1",
"DeviceVendor": "Altium",
"DeviceProduct": "365 Platform",
"DeviceVersion": "Cloud",
"DeviceEventClassId": "",
"Nome": "Login utente",
"Estensione": {
"dvchost": "host.domain.com",
"msg": "Accesso utente riuscito",
"rt": "2024-01-10T14:30:00Z",
"dtz": "UTC+00:00",
"suser": "sampleuser",
"act": "login",
"externalId": "45678",
"cat": "authentication"
}
}
]
}
Campi di primo livello
Campo |
Tipo |
Descrizione |
|
intero |
Numero totale di eventi disponibili in tutte le pagine |
|
array |
Eventi nella pagina corrente |
Campi evento
Campo |
Tipo |
Descrizione |
|
stringa |
Versione CEF |
|
stringa |
Sempre |
|
stringa |
Sempre |
|
stringa |
Sempre |
|
stringa |
Identificatore della classe dell'evento |
|
stringa |
Nome dell'evento leggibile dall'uomo (ad es. |
|
oggetto |
Dati dettagliati dell'evento - vedere sotto |
Campi di estensione
Campo |
Tipo |
Descrizione |
|
stringa |
Nome di dominio completamente qualificato dell'area di lavoro |
|
stringa |
Descrizione dell'evento leggibile dall'uomo |
|
stringa |
Timestamp dell'evento (ISO 8601) |
|
stringa |
Fuso orario (es. |
|
stringa |
Nome utente associato all'evento |
|
stringa |
Azione eseguita (ad es. |
|
stringa |
ID dell'entità di origine |
|
stringa |
Categoria dell'evento (es. |
Paginazione
Utilizza TotalCountOffsetLimit
Pagina 1: Offset=0, Limite=500 → eventi 1-500 Pagina 2: Offset=500, Limite=500 → eventi 501-1000 ...
Codici di stato HTTP
Codice |
Significato |
|
Eventi restituiti con successo |
|
|
|
Credenziali non valide o licenza Enterprise non attiva |
Ulteriori letture
Esportazione di audit in Altium 365 - Impostazione e configurazione dell'amministratore dell'area di lavoro.