API SIEM
L’API SIEM expose les événements d’audit du Workspace sous forme de flux JSON paginé, compatible avec la norme Common Event Format (CEF). Utilisez-la pour ingérer les journaux d’audit d’Altium 365 dans votre système de Security Information and Event Management (SIEM) ou dans tout autre outil externe de conformité.
Trouver votre endpoint et vos identifiants
Chaque Workspace possède sa propre URL d’endpoint d’audit et ses propres identifiants. Pour les trouver :
-
Accédez à Admin → Settings → Audit Export dans votre Workspace.
-
Copiez le Endpoint URL, le Client ID et le Secret Key.
Vous pouvez régénérer ou révoquer la Secret Key depuis cette page à tout moment. La régénération d’une clé invalide immédiatement la précédente.
Authentification
Chaque requête nécessite deux en-têtes personnalisés :
Header |
Value |
|
Votre Workspace Client ID |
|
Votre Workspace Secret Key |
Récupération des événements
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Paramètres de requête
Paramètre |
Obligatoire |
Description |
|
Non |
Position de départ dans l’ensemble de résultats. Par défaut : |
|
Non |
Nombre maximal d’événements à renvoyer. Ne peut pas dépasser le maximum de l’API ; si cette limite est dépassée, |
Exemple Curl
curl -G '{your-audit-endpoint}' \
-H 'ClientId: {your-client-id}' \
-H 'ClientSecret: {your-secret-key}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Format de réponse
{
"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"
}
}
]
}
Champs de premier niveau
Champ |
Type |
Description |
|
integer |
Nombre total d’événements disponibles sur l’ensemble des pages |
|
array |
Événements sur la page actuelle |
Champs d’événement
Champ |
Type |
Description |
|
string |
Version CEF |
|
string |
Toujours |
|
string |
Toujours |
|
string |
Toujours |
|
string |
Identifiant de classe de l’événement |
|
string |
Nom de l’événement lisible par un humain (par ex. |
|
object |
Données détaillées de l’événement – voir ci-dessous |
Champs d’extension
Champ |
Type |
Description |
|
string |
Nom de domaine pleinement qualifié du Workspace |
|
string |
Description de l’événement lisible par un humain |
|
string |
Horodatage de l’événement (ISO 8601) |
|
string |
Fuseau horaire (par ex. |
|
string |
Nom d’utilisateur associé à l’événement |
|
string |
Action effectuée (par ex. |
|
string |
ID de l’entité d’origine |
|
string |
Catégorie de l’événement (par ex. |
Pagination
Utilisez TotalCount de la première réponse pour déterminer combien de pages récupérer. Incrémentez Offset de votre Limit à chaque requête suivante jusqu’à ce que tous les événements aient été récupérés.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Codes d’état HTTP
Code |
Signification |
|
Événements renvoyés avec succès |
|
|
|
Identifiants invalides, ou licence Enterprise non active |
Pour en savoir plus
Audit Export dans Altium 365 – configuration et paramétrage de l’administration du Workspace.