SIEM API

SIEM API は、Workspace の監査イベントを、Common Event Format (CEF) 標準に準拠したページネーション対応の JSON フィードとして公開します。これを使用して、Altium 365 の監査ログを Security Information and Event Management (SIEM) システム、または外部のコンプライアンスツールに取り込むことができます。

Enterprise license required. Audit Export オプションは、Enterprise レベルのライセンスが有効な場合にのみ、Workspace Admin 設定に表示されます。

エンドポイントと認証情報の確認

各 Workspace には、それぞれ固有の監査エンドポイント URL と認証情報があります。確認手順は次のとおりです。

  1. Workspace の Admin → Settings → Audit Export に移動します。

  2. Endpoint URLClient IDSecret Key をコピーします。

このページでは、Secret Key をいつでも再生成または無効化できます。キーを再生成すると、それまでのキーは直ちに無効になります。

認証

すべてのリクエストには、次の 2 つのカスタムヘッダーが必要です。

Header

Value

ClientId

Workspace の Client ID

ClientSecret

Workspace の Secret Key

イベントの取得

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

integer

全ページを通じて取得可能なイベント総数

Events

array

現在のページのイベント

イベントフィールド

フィールド

説明

CefVersion

string

CEF バージョン

DeviceVendor

string

常に "Altium"

DeviceProduct

string

常に "365 Platform"

DeviceVersion

string

常に "Cloud"

DeviceEventClassId

string

イベントクラス識別子

Name

string

人が読める形式のイベント名(例: "User Login"

Extension

object

詳細なイベントデータ - 下記を参照

Extension フィールド

フィールド

説明

dvchost

string

Workspace の完全修飾ドメイン名

msg

string

人が読める形式のイベント説明

rt

string

イベントのタイムスタンプ(ISO 8601)

dtz

string

タイムゾーン(例: "UTC+00:00"

suser

string

イベントに関連付けられたユーザー名

act

string

実行されたアクション(例: "login""create""delete"

externalId

string

発生元エンティティ ID

cat

string

イベントカテゴリ(例: "authentication""design"

ページネーション

最初のレスポンスの TotalCount を使用して、取得すべきページ数を判断します。以降の各リクエストでは、すべてのイベントを取得するまで、OffsetLimit ずつ増やしてください。

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 の Audit Export - Workspace 管理者向けのセットアップと設定。

 

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Content