API SIEM

L’API SIEM expose les événements d’audit du 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 Altium 365 dans votre système de gestion des informations et des événements de sécurité (SIEM) ou dans tout autre outil externe de conformité.

Enterprise license required. L’option Export d’audit n’apparaît dans les paramètres d’administration du Workspace que lorsqu’une licence de niveau Enterprise est active.

Trouver votre point de terminaison et vos identifiants

Chaque Workspace possède sa propre URL de point de terminaison d’audit et ses propres identifiants. Pour les trouver :

  1. Accédez à Admin → Settings → Audit Export dans votre Workspace.

  2. Copiez le Endpoint URL, le Client ID et le Secret Key.

Vous pouvez régénérer ou révoquer la clé secrète 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

ClientId

L’ID client de votre Workspace

ClientSecret

La clé secrète de votre Workspace

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

Offset

Non

Position de départ dans l’ensemble de résultats. Par défaut : 0

Limit

Non

Nombre maximal d’événements à renvoyer. Ne peut pas dépasser le maximum de l’API ; en cas de dépassement, 400 est renvoyé.

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

TotalCount

integer

Nombre total d’événements disponibles sur l’ensemble des pages

Events

array

Événements de la page en cours

Champs d’événement

Champ

Type

Description

CefVersion

string

Version CEF

DeviceVendor

string

Toujours "Altium"

DeviceProduct

string

Toujours "365 Platform"

DeviceVersion

string

Toujours "Cloud"

DeviceEventClassId

string

Identifiant de classe d’événement

Name

string

Nom d’événement lisible par l’humain (par ex. "User Login")

Extension

object

Données détaillées de l’événement – voir ci-dessous

Champs d’extension

Champ

Type

Description

dvchost

string

Nom de domaine pleinement qualifié du Workspace

msg

string

Description lisible par l’humain de l’événement

rt

string

Horodatage de l’événement (ISO 8601)

dtz

string

Fuseau horaire (par ex. "UTC+00:00")

suser

string

Nom d’utilisateur associé à l’événement

act

string

Action effectuée (par ex. "login", "create", "delete")

externalId

string

ID de l’entité d’origine

cat

string

Catégorie d’événement (par ex. "authentication", "design")

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

200 OK

Événements renvoyés avec succès

400 Bad Request

Limit dépasse le maximum de l’API

401 Unauthorized

Identifiants invalides ou licence Enterprise non active

Pour aller plus loin

Export d’audit dans Altium 365 – configuration et paramétrage de l’administration du Workspace.

 

AI-LocalizedLocalisé par IA
Si vous trouvez un problème, sélectionnez le texte/l’image et appuyez surCtrl + Entréepour nous envoyer vos commentaires.
Contenu