API SIEM
Interfejs API SIEM udostępnia zdarzenia audytu Workspace jako stronicowany kanał JSON, zgodny ze standardem Common Event Format (CEF). Użyj go do importowania dzienników audytu Altium 365 do swojego systemu Security Information and Event Management (SIEM) lub dowolnych zewnętrznych narzędzi do zgodności.
Znajdowanie punktu końcowego i poświadczeń
Każdy Workspace ma własny adres URL punktu końcowego audytu i własne poświadczenia. Aby je znaleźć:
-
Przejdź do Admin → Settings → Audit Export w swoim Workspace.
-
Skopiuj Endpoint URL, Client ID i Secret Key.
W dowolnym momencie możesz ponownie wygenerować lub unieważnić Secret Key na tej stronie. Ponowne wygenerowanie klucza natychmiast unieważnia poprzedni.
Uwierzytelnianie
Każde żądanie wymaga dwóch niestandardowych nagłówków:
Header |
Value |
|
Client ID Twojego Workspace |
|
Secret Key Twojego Workspace |
Pobieranie zdarzeń
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Parametry zapytania
Parametr |
Wymagany |
Opis |
|
Nie |
Pozycja początkowa w zbiorze wyników. Domyślnie: |
|
Nie |
Maksymalna liczba zdarzeń do zwrócenia. Nie może przekroczyć maksimum API; przekroczenie zwraca |
Przykład 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 odpowiedzi
{
"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"
}
}
]
}
Pola najwyższego poziomu
Pole |
Typ |
Opis |
|
integer |
Łączna liczba zdarzeń dostępnych na wszystkich stronach |
|
array |
Zdarzenia na bieżącej stronie |
Pola zdarzenia
Pole |
Typ |
Opis |
|
string |
Wersja CEF |
|
string |
Zawsze |
|
string |
Zawsze |
|
string |
Zawsze |
|
string |
Identyfikator klasy zdarzenia |
|
string |
Czytelna dla człowieka nazwa zdarzenia (np. |
|
object |
Szczegółowe dane zdarzenia – patrz poniżej |
Pola rozszerzenia
Pole |
Typ |
Opis |
|
string |
W pełni kwalifikowana nazwa domenowa Workspace |
|
string |
Czytelny dla człowieka opis zdarzenia |
|
string |
Znacznik czasu zdarzenia (ISO 8601) |
|
string |
Strefa czasowa (np. |
|
string |
Nazwa użytkownika powiązana ze zdarzeniem |
|
string |
Wykonana akcja (np. |
|
string |
ID encji źródłowej |
|
string |
Kategoria zdarzenia (np. |
Stronicowanie
Użyj TotalCount z pierwszej odpowiedzi, aby określić, ile stron należy pobrać. Zwiększaj Offset o wartość Limit przy każdym kolejnym żądaniu, aż wszystkie zdarzenia zostaną pobrane.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Kody statusu HTTP
Kod |
Znaczenie |
|
Zdarzenia zostały pomyślnie zwrócone |
|
|
|
Nieprawidłowe poświadczenia lub nieaktywna licencja Enterprise |
Dalsza lektura
Audit Export w Altium 365 – konfiguracja i ustawienia administratora Workspace.