API SIEM
L’API SIEM espone gli eventi di audit del Workspace come feed JSON paginato, compatibile con lo standard Common Event Format (CEF). Usala per acquisire i log di audit di Altium 365 nel tuo sistema Security Information and Event Management (SIEM) o in qualsiasi strumento esterno per la conformità.
Individuazione dell’endpoint e delle credenziali
Ogni Workspace dispone di un proprio URL endpoint di audit e delle relative credenziali. Per trovarli:
-
Vai a Admin → Settings → Audit Export nel tuo Workspace.
-
Copia il Endpoint URL, il Client ID e il Secret Key.
Puoi rigenerare o revocare la Secret Key da questa pagina in qualsiasi momento. La rigenerazione di una chiave invalida immediatamente quella precedente.
Autenticazione
Ogni richiesta richiede due header personalizzati:
Header |
Value |
|
Il Client ID del tuo Workspace |
|
La Secret Key del tuo Workspace |
Recupero degli eventi
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Parametri di query
Parametro |
Obbligatorio |
Descrizione |
|
No |
Posizione iniziale nel set di risultati. Predefinito: |
|
No |
Numero massimo di eventi da restituire. Non può superare il massimo dell’API; se viene superato, viene restituito |
Esempio 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 della risposta
{
"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"
}
}
]
}
Campi di primo livello
Campo |
Tipo |
Descrizione |
|
integer |
Numero totale di eventi disponibili in tutte le pagine |
|
array |
Eventi nella pagina corrente |
Campi evento
Campo |
Tipo |
Descrizione |
|
string |
Versione CEF |
|
string |
Sempre |
|
string |
Sempre |
|
string |
Sempre |
|
string |
Identificatore della classe di evento |
|
string |
Nome evento leggibile dall’utente (ad es. |
|
object |
Dati dettagliati dell’evento – vedi sotto |
Campi di estensione
Campo |
Tipo |
Descrizione |
|
string |
Nome di dominio completo del Workspace |
|
string |
Descrizione dell’evento leggibile dall’utente |
|
string |
Timestamp dell’evento (ISO 8601) |
|
string |
Fuso orario (ad es. |
|
string |
Nome utente associato all’evento |
|
string |
Azione eseguita (ad es. |
|
string |
ID dell’entità di origine |
|
string |
Categoria dell’evento (ad es. |
Paginazione
Usa TotalCount della prima risposta per determinare quante pagine recuperare. Incrementa Offset del tuo Limit a ogni richiesta successiva finché non sono stati recuperati tutti gli eventi.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Codici di stato HTTP
Codice |
Significato |
|
Eventi restituiti correttamente |
|
|
|
Credenziali non valide oppure licenza Enterprise non attiva |
Letture aggiuntive
Audit Export in Altium 365 – configurazione e impostazione per l’amministrazione del Workspace.