SIEM API
SIEM API は、Workspace の監査イベントを、Common Event Format (CEF) 標準に準拠したページネーション対応の JSON フィードとして公開します。これを使用して、Altium 365 の監査ログを Security Information and Event Management (SIEM) システム、または外部のコンプライアンスツールに取り込むことができます。
エンドポイントと認証情報の確認
各 Workspace には、それぞれ固有の監査エンドポイント URL と認証情報があります。確認手順は次のとおりです。
-
Workspace の Admin → Settings → Audit Export に移動します。
-
Endpoint URL、Client ID、Secret Key をコピーします。
このページでは、Secret Key をいつでも再生成または無効化できます。キーを再生成すると、それまでのキーは直ちに無効になります。
認証
すべてのリクエストには、次の 2 つのカスタムヘッダーが必要です。
Header |
Value |
|
Workspace の Client ID |
|
Workspace の Secret Key |
イベントの取得
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"
}
}
]
}
トップレベルフィールド
フィールド |
型 |
説明 |
|
integer |
全ページを通じて取得可能なイベント総数 |
|
array |
現在のページのイベント |
イベントフィールド
フィールド |
型 |
説明 |
|
string |
CEF バージョン |
|
string |
常に |
|
string |
常に |
|
string |
常に |
|
string |
イベントクラス識別子 |
|
string |
人が読める形式のイベント名(例: |
|
object |
詳細なイベントデータ - 下記を参照 |
Extension フィールド
フィールド |
型 |
説明 |
|
string |
Workspace の完全修飾ドメイン名 |
|
string |
人が読める形式のイベント説明 |
|
string |
イベントのタイムスタンプ(ISO 8601) |
|
string |
タイムゾーン(例: |
|
string |
イベントに関連付けられたユーザー名 |
|
string |
実行されたアクション(例: |
|
string |
発生元エンティティ ID |
|
string |
イベントカテゴリ(例: |
ページネーション
最初のレスポンスの 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 の Audit Export - Workspace 管理者向けのセットアップと設定。