API SIEM

API SIEM предоставляет события аудита Workspace в виде постраничной JSON-ленты, совместимой со стандартом Common Event Format (CEF). Используйте его для загрузки журналов аудита Altium 365 в вашу систему Security Information and Event Management (SIEM) или любые внешние средства контроля соответствия требованиям.

Как найти endpoint и учетные данные

У каждого Workspace есть собственный URL конечной точки аудита и свои учетные данные. Чтобы найти их:

1. Перейдите в Admin → Settings → Audit Export в вашем Workspace.

2. Скопируйте Endpoint URL, Client ID и Secret Key.

На этой странице вы можете в любой момент заново сгенерировать или отозвать Secret Key. При повторной генерации ключа предыдущий ключ немедленно становится недействительным.

Аутентификация

Для каждого запроса требуются два пользовательских заголовка:

Получение событий

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

Параметры запроса

Пример Curl

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

Формат ответа

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

Поля верхнего уровня

Поля события

Поля расширения

Пагинация

Используйте TotalCount из первого ответа, чтобы определить, сколько страниц нужно получить. Увеличивайте Offset на значение вашего Limit в каждом последующем запросе, пока не будут получены все события.

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

Коды состояния HTTP

Дополнительные материалы

Audit Export в Altium 365 – настройка и конфигурация администрирования Workspace.