SIEM API
SIEM API 以分页 JSON 流的形式公开 Workspace 审计事件,与通用事件格式 (CEF) 标准兼容。使用它可将 Altium 365 审计日志摄取到安全信息和事件管理 (SIEM) 系统或任何外部合规性工具中。
查找端点和凭证
每个工作区都有自己的审计端点 URL 和凭证。要找到它们
-
转到
工作区。Admin → Settings → Audit Export -
复制图标
,Endpoint URL 和Client ID .Secret Key
您可以随时从该页面重新生成或撤销秘钥。重新生成密钥后,先前的密钥立即失效。
身份验证
每个请求都需要两个自定义标头:
|
您的工作区客户端标识符 |
|
您的工作区密匙 |
事件检索
GET {your-audit-endpoint}?offset=0&limit=500
客户端 ID:{您的客户端 ID}
ClientSecret : {your-secret-key} 客户端密钥
请求参数
参数 |
必须填写 |
请求描述 |
|
无 |
结果集中的起始位置。默认值 : |
|
无 |
返回事件的最大数量。不能超过 API 的最大值;超过时将返回 |
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" : "身份验证
}
}
]
}
顶级字段
字段 |
字段类型 |
说明 |
|
整数 |
所有页面上可用的事件总数 |
|
表格 |
当前页面上的事件 |
事件字段
字段 |
字段类型 |
说明 |
|
字符串 |
EFC 版本 |
|
字符串 |
始终 |
|
频道 |
总是 |
|
频道 |
总是 |
|
频道 |
事件类别标识符 |
|
字符串 |
人类可读的事件名称(如 |
|
对象 |
事件详情--见下文 |
扩展字段
字段 |
字段类型 |
字段类型 |
|
字符串 |
工作区的全域名 |
|
字符串 |
可读事件描述 |
|
字符串 |
事件时间戳(ISO 8601) |
|
字符串 |
时区(例如 |
|
频道 |
与事件相关的用户名 |
|
字符串 |
采取的行动(例如 |
|
字符串 |
原始实体的 ID |
|
字符串 |
事件类别(例如 |
分页
使用 TotalCountOffsetLimit
第 1 页:偏移=0,限制=500 → 事件 1-500 第 2 页:偏移=500,限制=500 → 事件 501-1000 ...
HTTP 状态代码
状态代码 |
状态代码 |
|
事件成功返回 |
|
|
|
证书无效或企业许可证未激活 |
了解更多信息
Altium 365 中的审计导出- 工作区管理员设置和配置。