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 systemu Security Information and Event Management (SIEM) lub dowolnego zewnętrznego narzędzia do zapewniania zgodności.

Enterprise license required. Opcja Audit Export pojawia się w ustawieniach Workspace Admin tylko wtedy, gdy aktywna jest licencja na poziomie Enterprise.

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źć:

  1. Przejdź do Admin → Settings → Audit Export w swoim Workspace.

  2. Skopiuj Endpoint URL, Client ID i Secret Key.

Na tej stronie możesz w dowolnym momencie ponownie wygenerować lub unieważnić Secret Key. Ponowne wygenerowanie klucza natychmiast unieważnia poprzedni.

Uwierzytelnianie

Każde żądanie wymaga dwóch niestandardowych nagłówków:

Header

Value

ClientId

Client ID Twojego Workspace

ClientSecret

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

Offset

Nie

Pozycja początkowa w zestawie wyników. Domyślnie: 0

Limit

Nie

Maksymalna liczba zdarzeń do zwrócenia. Nie może przekraczać maksimum API; jego przekroczenie powoduje zwrócenie 400.

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

TotalCount

integer

Łączna liczba zdarzeń dostępnych na wszystkich stronach

Events

array

Zdarzenia na bieżącej stronie

Pola zdarzenia

Pole

Typ

Opis

CefVersion

string

Wersja CEF

DeviceVendor

string

Zawsze "Altium"

DeviceProduct

string

Zawsze "365 Platform"

DeviceVersion

string

Zawsze "Cloud"

DeviceEventClassId

string

Identyfikator klasy zdarzenia

Name

string

Czytelna dla człowieka nazwa zdarzenia (np. "User Login")

Extension

object

Szczegółowe dane zdarzenia – patrz poniżej

Pola rozszerzenia

Pole

Typ

Opis

dvchost

string

W pełni kwalifikowana nazwa domenowa Workspace

msg

string

Czytelny dla człowieka opis zdarzenia

rt

string

Znacznik czasu zdarzenia (ISO 8601)

dtz

string

Strefa czasowa (np. "UTC+00:00")

suser

string

Nazwa użytkownika powiązana ze zdarzeniem

act

string

Wykonana akcja (np. "login", "create", "delete")

externalId

string

ID jednostki źródłowej

cat

string

Kategoria zdarzenia (np. "authentication", "design")

Stronicowanie

Użyj TotalCount z pierwszej odpowiedzi, aby określić, ile stron należy pobrać. Zwiększaj Offset o wartość Limit w każdym kolejnym żądaniu, aż wszystkie zdarzenia zostaną pobrane.

Strona 1: Offset=0,   Limit=500   → zdarzenia 1–500
Strona 2: Offset=500, Limit=500   → zdarzenia 501–1000
...

Kody statusu HTTP

Kod

Znaczenie

200 OK

Zdarzenia zostały zwrócone pomyślnie

400 Bad Request

Limit przekracza maksimum API

401 Unauthorized

Nieprawidłowe poświadczenia lub licencja Enterprise nie jest aktywna

Dalsza lektura

Audit Export w Altium 365 – konfiguracja i ustawienia administracyjne Workspace.

 

AI-LocalizedTłumaczenie SI
Jeśli znajdziesz błąd, zaznacz tekst/obraz i naciśnij Ctrl + Enter aby wysłać nam wiadomość.
Content