API SIEM
Краткий обзор
- Найдите конечную точку аудита и учетные данные своего рабочего пространства и узнайте, как повторно сгенерировать или отозвать секретный ключ.
- Получайте события аудита с помощью заголовков аутентификации и параметров запроса, используя практический пример команды curl.
- Разберитесь в полях ответа, получите все доступные события с помощью постраничной выдачи и узнайте, как интерпретировать коды состояния HTTP.
SIEM API предоставляет события аудита рабочего пространства в виде JSON-ленты с постраничной выдачей, совместимой со стандартом Common Event Format (CEF). Используйте его для загрузки журналов аудита Altium 365 в вашу систему управления информацией и событиями безопасности (SIEM) или любые внешние инструменты контроля соответствия нормативным требованиям.
Поиск конечной точки и учетных данных
У каждого рабочего пространства есть собственные URL конечной точки аудита и учетные данные. Чтобы найти их:
-
Перейдите в Admin → Settings → Audit Export в своем рабочем пространстве.
-
Скопируйте Endpoint URL, Client ID и Secret Key.
На этой странице можно в любой момент создать новый секретный ключ или отозвать существующий. При создании нового ключа предыдущий немедленно становится недействительным.
Аутентификация
Каждый запрос должен содержать два специальных заголовка:
Header |
Value |
|
Идентификатор клиента вашего рабочего пространства |
|
Секретный ключ вашего рабочего пространства |
Получение событий
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Параметры запроса
Параметр |
Обязательный |
Описание |
|
Нет |
Начальная позиция в наборе результатов. По умолчанию: |
|
Нет |
Максимальное количество возвращаемых событий. Не должно превышать установленный API предел; при его превышении возвращается |
Пример 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"
}
}
]
}
Поля верхнего уровня
Поле |
Тип |
Описание |
|
целое число |
Общее количество событий, доступных на всех страницах |
|
массив |
События на текущей странице |
Поля события
Поле |
Тип |
Описание |
|
строка |
Версия CEF |
|
строка |
Всегда |
|
строка |
Всегда |
|
строка |
Всегда |
|
строка |
Идентификатор класса события |
|
строка |
Понятное пользователю название события (например, |
|
объект |
Подробные данные события — см. ниже |
Поля расширения
Поле |
Тип |
Описание |
|
строка |
Полное доменное имя рабочего пространства |
|
строка |
Понятное пользователю описание события |
|
строка |
Временная метка события (ISO 8601) |
|
строка |
Часовой пояс (например, |
|
строка |
Имя пользователя, связанного с событием |
|
строка |
Выполненное действие (например, |
|
строка |
Идентификатор сущности — источника события |
|
строка |
Категория события (например, |
Постраничная выдача
Используйте TotalCount из первого ответа, чтобы определить, сколько страниц необходимо получить. В каждом последующем запросе увеличивайте Offset на значение Limit, пока не будут получены все события.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Коды состояния HTTP
Код |
Значение |
|
События успешно возвращены |
|
|
|
Недействительные учетные данные или неактивная лицензия Enterprise |
Дополнительные материалы
Экспорт аудита в Altium 365 — настройка и конфигурирование администратором рабочего пространства.