SIEM-API

Die SIEM-API stellt Workspace-Audit-Ereignisse als paginierten JSON-Feed bereit, der mit dem Standard Common Event Format (CEF) kompatibel ist. Verwenden Sie sie, um Altium 365-Auditprotokolle in Ihr Security Information and Event Management (SIEM)-System oder in beliebige externe Compliance-Tools zu übernehmen.

Enterprise license required. Die Option „Audit Export“ wird in den Workspace-Admin-Einstellungen nur angezeigt, wenn eine Lizenz auf Enterprise-Ebene aktiv ist.

Ihren Endpunkt und Ihre Anmeldedaten finden

Jeder Workspace verfügt über eine eigene Audit-Endpunkt-URL und eigene Anmeldedaten. So finden Sie sie:

  1. Gehen Sie zu Admin → Settings → Audit Export in Ihrem Workspace.

  2. Kopieren Sie die Endpoint URL, Client ID und Secret Key.

Sie können den Secret Key auf dieser Seite jederzeit neu generieren oder widerrufen. Durch das Neugenerieren eines Schlüssels wird der vorherige sofort ungültig.

Authentifizierung

Jede Anfrage erfordert zwei benutzerdefinierte Header:

Header

Value

ClientId

Ihre Workspace Client ID

ClientSecret

Ihr Workspace Secret Key

Ereignisse abrufen

GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}

Abfrageparameter

Parameter

Erforderlich

Beschreibung

Offset

Nein

Startposition in der Ergebnismenge. Standard: 0

Limit

Nein

Maximale Anzahl der zurückzugebenden Ereignisse. Darf das API-Maximum nicht überschreiten; bei Überschreitung wird 400 zurückgegeben.

Curl-Beispiel

curl -G '{your-audit-endpoint}' \
  -H 'ClientId: {your-client-id}' \
  -H 'ClientSecret: {your-secret-key}' \
  --data-urlencode 'Offset=0' \
  --data-urlencode 'Limit=500'

Antwortformat

{
  "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"
      }
    }
  ]
}

Felder der obersten Ebene

Feld

Typ

Beschreibung

TotalCount

integer

Gesamtzahl der über alle Seiten verfügbaren Ereignisse

Events

array

Ereignisse auf der aktuellen Seite

Ereignisfelder

Feld

Typ

Beschreibung

CefVersion

string

CEF-Version

DeviceVendor

string

Immer "Altium"

DeviceProduct

string

Immer "365 Platform"

DeviceVersion

string

Immer "Cloud"

DeviceEventClassId

string

Ereignisklassenkennung

Name

string

Menschenlesbarer Ereignisname (z. B. "User Login")

Extension

object

Detaillierte Ereignisdaten – siehe unten

Erweiterungsfelder

Feld

Typ

Beschreibung

dvchost

string

Voll qualifizierter Domainname des Workspace

msg

string

Menschenlesbare Ereignisbeschreibung

rt

string

Ereigniszeitstempel (ISO 8601)

dtz

string

Zeitzone (z. B. "UTC+00:00")

suser

string

Mit dem Ereignis verknüpfter Benutzername

act

string

Ausgeführte Aktion (z. B. "login", "create", "delete")

externalId

string

ID der auslösenden Entität

cat

string

Ereigniskategorie (z. B. "authentication", "design")

Paginierung

Verwenden Sie TotalCount aus der ersten Antwort, um zu bestimmen, wie viele Seiten abgerufen werden müssen. Erhöhen Sie Offset bei jeder nachfolgenden Anfrage um Ihr Limit, bis alle Ereignisse abgerufen wurden.

Page 1: Offset=0,   Limit=500   → events 1–500
Page 2: Offset=500, Limit=500   → events 501–1000
...

HTTP-Statuscodes

Code

Bedeutung

200 OK

Ereignisse erfolgreich zurückgegeben

400 Bad Request

Limit überschreitet das API-Maximum

401 Unauthorized

Ungültige Anmeldedaten oder Enterprise-Lizenz nicht aktiv

Weiterführende Informationen

Audit Export in Altium 365 – Einrichtung und Konfiguration durch den Workspace-Administrator.

 

AI-LocalizedAI-localized
Wenn Sie ein Problem feststellen, wählen Sie den Text/das Bild aus und drücken SieStrg + Eingabe, um uns Ihr Feedback zu senden.
Inhalt