API SIEM
L'API SIEM expose les événements d'audit de Workspace sous la forme d'un 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 gestion des informations et des événements de sécurité (SIEM) ou dans tout outil de conformité externe.
Trouver votre point de terminaison et vos informations d'identification
Chaque espace de travail possède sa propre URL de point final d'audit et ses propres informations d'identification. Pour les trouver :
-
Allez sur
Admin → Settings → Audit Export dans votre espace de travail. -
Copiez l'icône
Endpoint URL ,Client ID etSecret Key .
Vous pouvez à tout moment régénérer ou révoquer la clé secrète à partir de cette page. 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 :
|
Votre identifiant client de l'espace de travail |
|
Votre clé secrète Workspace |
Récupération d'événements
GET {votre-audit-endpoint}?Offset=0&Limit=500
ClientId : {votre-identifiant-client}
ClientSecret : {votre-clé-secrète}
Paramètres de la requête
Paramètre |
Obligatoire |
Description de la requête |
|
Non |
Position de départ dans l'ensemble des résultats. Valeur par défaut : |
|
Non |
Nombre maximal d'événements à renvoyer. Ne peut excéder le maximum de l'API ; le dépasser renvoie |
Exemple Curl
curl -G '{votre-audit-endpoint}' \N- 'H' 'ClientId' : 'ClientId' : 'ClientId' : 'ClientId'
-H 'ClientId : {votre-identifiant-client}' \N- H 'ClientSecret : {votre-clé-secrète}' \N- H
-H 'ClientSecret : {votre-clé-secrète}' \N- 'ClientSecret : {votre-clé-secrète}' -data-urlencode 'Offset=0
--data-urlencode "Offset=0" \N -data-urlencode "Offset=0" \N
--data-urlencode 'Limit=500'
Format de la réponse
{
"TotalCount" : 2,
"Events" : [
{
"CefVersion" : "1",
"DeviceVendor" : "Altium",
"DeviceProduct" : "365 Platform",
"DeviceVersion" : "Cloud",
"DeviceEventClassId" : "",
"Name" : "User Login",
"Extension" : {
"dvchost" : "host.domain.com",
"msg" : "Connexion réussie de l'utilisateur",
"rt" : "2024-01-10T14:30:00Z",
"dtz" : "UTC+00:00",
"suser" : "sampleuser",
"act" : "login",
"externalId" : "45678",
"cat" : "authentication"
}
}
]
}
Champs de premier niveau
Champ |
Type de champ |
Description |
|
entier |
Nombre total d'événements disponibles sur toutes les pages |
|
tableau |
Événements sur la page en cours |
Champs d'événements
Champ |
Type de champ |
Description |
|
chaîne |
Version du CEF |
|
chaîne |
Toujours |
|
chaîne |
Toujours |
|
chaîne |
Toujours |
|
chaîne |
Identifiant de la classe d'événement |
|
chaîne |
Nom de l'événement lisible par l'homme (par ex. |
|
objet |
Données détaillées de l'événement - voir ci-dessous |
Champs d'extension
Champ |
Type de champ |
Description |
|
chaîne |
Nom de domaine complet de l'espace de travail |
|
chaîne |
Description de l'événement lisible par l'homme |
|
chaîne |
Horodatage de l'événement (ISO 8601) |
|
chaîne |
Fuseau horaire (par exemple |
|
chaîne |
Nom d'utilisateur associé à l'événement |
|
chaîne |
Action effectuée (par ex. |
|
chaîne de caractères |
ID de l'entité d'origine |
|
chaîne |
Catégorie d'événement (par ex. |
Pagination
Utiliser les TotalCountOffsetLimit
Page 1 : Décalage=0, Limite=500 → événements 1-500 Page 2 : décalage=500, limite=500 → événements 501-1000 ...
Codes d'état HTTP
Code d'état |
Signification |
|
Événements renvoyés avec succès |
|
|
|
Informations d'identification non valides ou licence Enterprise non active |
Pour en savoir plus
Audit Export in Altium 365 - Workspace admin setup and configuration.