API SIEM

Краткий обзор

SIEM API позволяет получать события аудита рабочего пространства Altium 365 в виде JSON-потока с поддержкой постраничной выдачи и совместимостью с CEF для вашей SIEM-системы или внешних инструментов контроля соответствия требованиям. В этой статье рассматриваются требование к наличию лицензии Enterprise, поиск адреса конечной точки и учетных данных, аутентификация запросов, а также интерпретация данных событий и HTTP-ответов. Читайте дальше, чтобы сделать следующий шаг к подключению журналов аудита рабочего пространства к вашим средствам обеспечения безопасности.

- Найдите конечную точку аудита и учетные данные своего рабочего пространства и узнайте, как повторно сгенерировать или отозвать секретный ключ.
- Получайте события аудита с помощью заголовков аутентификации и параметров запроса, используя практический пример команды curl.
- Разберитесь в полях ответа, получите все доступные события с помощью постраничной выдачи и узнайте, как интерпретировать коды состояния HTTP.
Узнайте больше с ИИ:

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

Enterprise license required. Параметр экспорта аудита отображается в настройках администратора рабочего пространства только при наличии активной лицензии уровня Enterprise.

Поиск конечной точки и учетных данных

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

  1. Перейдите в Admin → Settings → Audit Export в своем рабочем пространстве.

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

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

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

Каждый запрос должен содержать два специальных заголовка:

Header

Value

ClientId

Идентификатор клиента вашего рабочего пространства

ClientSecret

Секретный ключ вашего рабочего пространства

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

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

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

Параметр

Обязательный

Описание

Offset

Нет

Начальная позиция в наборе результатов. По умолчанию: 0

Limit

Нет

Максимальное количество возвращаемых событий. Не должно превышать установленный API предел; при его превышении возвращается 400.

Пример 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

целое число

Общее количество событий, доступных на всех страницах

Events

массив

События на текущей странице

Поля события

Поле

Тип

Описание

CefVersion

строка

Версия CEF

DeviceVendor

строка

Всегда "Altium"

DeviceProduct

строка

Всегда "365 Platform"

DeviceVersion

строка

Всегда "Cloud"

DeviceEventClassId

строка

Идентификатор класса события

Name

строка

Понятное пользователю название события (например, "User Login")

Extension

объект

Подробные данные события — см. ниже

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

Поле

Тип

Описание

dvchost

строка

Полное доменное имя рабочего пространства

msg

строка

Понятное пользователю описание события

rt

строка

Временная метка события (ISO 8601)

dtz

строка

Часовой пояс (например, "UTC+00:00")

suser

строка

Имя пользователя, связанного с событием

act

строка

Выполненное действие (например, "login", "create", "delete")

externalId

строка

Идентификатор сущности — источника события

cat

строка

Категория события (например, "authentication", "design")

Постраничная выдача

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

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

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

Код

Значение

200 OK

События успешно возвращены

400 Bad Request

Limit превышает установленный API предел

401 Unauthorized

Недействительные учетные данные или неактивная лицензия Enterprise

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

Экспорт аудита в Altium 365 — настройка и конфигурирование администратором рабочего пространства.

 

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents