SIEM API

SIEM API 以分页 JSON 流的形式公开 Workspace 审计事件,与通用事件格式 (CEF) 标准兼容。使用它可将 Altium 365 审计日志摄取到安全信息和事件管理 (SIEM) 系统或任何外部合规性工具中。

Enterprise license required.审计导出选项只有在企业级许可证激活时才会出现在工作区管理设置中。

查找端点和凭证

每个工作区都有自己的审计端点 URL 和凭证。要找到它们

  1. 转到 Admin → Settings → Audit Export工作区。

  2. 复制图标 Endpoint URL, Client IDSecret Key.

您可以随时从该页面重新生成或撤销秘钥。重新生成密钥后,先前的密钥立即失效。

身份验证

每个请求都需要两个自定义标头:

Header

Value

ClientId

您的工作区客户端标识符

ClientSecret

您的工作区密匙

事件检索

GET {your-audit-endpoint}?offset=0&limit=500
客户端 ID:{您的客户端 ID}
ClientSecret : {your-secret-key} 客户端密钥

请求参数

参数

必须填写

请求描述

Offset

结果集中的起始位置。默认值 : 0

Limit

返回事件的最大数量。不能超过 API 的最大值;超过时将返回 400.

Curl 示例

curl -G '{your-audit-endpoint}' (你的审计端点\H 'ClientId' : 'ClientId' : 'ClientId
  -H 'ClientId : {your-client-id}' \N- H 'ClientId : {your-client-id\H 'ClientSecret : {your-secret-key}' (客户密钥\H
  -H 'ClientSecret : {your-secret-key}' \N- 'ClientSecret : {your-secret-key\N- 'ClientSecret : {your-secret-key}' H -data-urlencode 'Offset=0
  --data-urlencode "Offset=0" \N -data-urlencode "Offset=0" \N
  --data-urlencode "限制=500

响应格式

{
  "TotalCount" : 2、
  "事件":[
    {
      "CefVersion" : "1"、
      "DeviceVendor" : "Altium"、
      "DeviceProduct" : "365 Platform"、
      "DeviceVersion" : "Cloud"、
      "DeviceEventClassId": ""、
      "名称":"用户登录
      "扩展":{
        "dvchost" : "host.domain.com"、
        "msg": "用户登录成功"、
        "rt":"2024-01-10T14:30:00Z"、
        "dtz":"UTC+00:00"、
        "suser": "sampleuser"、
        "行为":"登录"、
        "externalId" : "45678"、
        "cat" : "身份验证
      }
    }
  ]
}

顶级字段

字段

字段类型

说明

TotalCount

整数

所有页面上可用的事件总数

Events

表格

当前页面上的事件

事件字段

字段

字段类型

说明

CefVersion

字符串

EFC 版本

DeviceVendor

字符串

始终 "Altium"

DeviceProduct

频道

总是 "365 Platform"

DeviceVersion

频道

总是 "Cloud"

DeviceEventClassId

频道

事件类别标识符

Name

字符串

人类可读的事件名称(如 "User Login")

Extension

对象

事件详情--见下文

扩展字段

字段

字段类型

字段类型

dvchost

字符串

工作区的全域名

msg

字符串

可读事件描述

rt

字符串

事件时间戳(ISO 8601)

dtz

字符串

时区(例如 "UTC+00:00")

suser

频道

与事件相关的用户名

act

字符串

采取的行动(例如 "login", "create", "delete")

externalId

字符串

原始实体的 ID

cat

字符串

事件类别(例如 "authentication", "design")

分页

使用 TotalCount来确定要检索的页数。递增 Offset递增 Limit递增,直到检索完所有事件。

第 1 页:偏移=0,限制=500 → 事件 1-500
第 2 页:偏移=500,限制=500 → 事件 501-1000
...

HTTP 状态代码

状态代码

状态代码

200 OK

事件成功返回

400 Bad Request

Limit超出 API 最大值

401 Unauthorized

证书无效或企业许可证未激活

了解更多信息

Altium 365 中的审计导出- 工作区管理员设置和配置。

AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Content