API SIEM
API SIEM cung cấp các sự kiện kiểm tra (audit) của Workspace dưới dạng nguồn cấp dữ liệu JSON phân trang, tương thích với tiêu chuẩn Common Event Format (CEF). Hãy dùng API này để nạp nhật ký kiểm tra của Altium 365 vào hệ thống Security Information and Event Management (SIEM) hoặc bất kỳ công cụ tuân thủ bên ngoài nào.
Tìm Endpoint và Thông tin xác thực của bạn
Mỗi Workspace có URL endpoint kiểm tra và thông tin xác thực riêng. Để tìm chúng:
-
Đi tới Admin → Settings → Audit Export trong Workspace của bạn.
-
Sao chép Endpoint URL, Client ID và Secret Key.
Bạn có thể tạo lại hoặc thu hồi Secret Key từ trang này bất kỳ lúc nào. Việc tạo lại khóa sẽ ngay lập tức làm mất hiệu lực khóa trước đó.
Xác thực
Mỗi yêu cầu cần hai header tùy chỉnh:
Header |
Value |
|
Workspace Client ID của bạn |
|
Workspace Secret Key của bạn |
Lấy sự kiện
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Tham số truy vấn
Tham số |
Bắt buộc |
Mô tả |
|
Không |
Vị trí bắt đầu trong tập kết quả. Mặc định: |
|
Không |
Số lượng sự kiện tối đa được trả về. Không được vượt quá giới hạn tối đa của API; nếu vượt quá sẽ trả về |
Ví dụ Curl
curl -G '{your-audit-endpoint}' \
-H 'ClientId: {your-client-id}' \
-H 'ClientSecret: {your-secret-key}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Định dạng phản hồi
{
"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"
}
}
]
}
Các trường cấp cao nhất
Trường |
Kiểu |
Mô tả |
|
integer |
Tổng số sự kiện khả dụng trên tất cả các trang |
|
array |
Các sự kiện trên trang hiện tại |
Các trường sự kiện
Trường |
Kiểu |
Mô tả |
|
string |
Phiên bản CEF |
|
string |
Luôn là |
|
string |
Luôn là |
|
string |
Luôn là |
|
string |
Mã định danh lớp sự kiện |
|
string |
Tên sự kiện dễ đọc cho người dùng (ví dụ: |
|
object |
Dữ liệu sự kiện chi tiết – xem bên dưới |
Các trường mở rộng
Trường |
Kiểu |
Mô tả |
|
string |
Tên miền đầy đủ của Workspace |
|
string |
Mô tả sự kiện dễ đọc cho người dùng |
|
string |
Dấu thời gian sự kiện (ISO 8601) |
|
string |
Múi giờ (ví dụ: |
|
string |
Tên người dùng liên quan đến sự kiện |
|
string |
Hành động được thực hiện (ví dụ: |
|
string |
ID của thực thể khởi phát |
|
string |
Danh mục sự kiện (ví dụ: |
Phân trang
Dùng TotalCount từ phản hồi đầu tiên để xác định cần lấy bao nhiêu trang. Tăng Offset theo giá trị Limit của bạn trong mỗi yêu cầu tiếp theo cho đến khi truy xuất hết tất cả sự kiện.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Mã trạng thái HTTP
Mã |
Ý nghĩa |
|
Các sự kiện đã được trả về thành công |
|
|
|
Thông tin xác thực không hợp lệ hoặc giấy phép Enterprise chưa được kích hoạt |
Đọc thêm
Audit Export trong Altium 365 – thiết lập và cấu hình quản trị Workspace.