API SIEM
A API SIEM expõe os eventos de auditoria do Workspace como um feed JSON paginado, compatível com o padrão Common Event Format (CEF). Use-a para ingerir logs de auditoria do Altium 365 no seu sistema de Security Information and Event Management (SIEM) ou em qualquer ferramenta externa de conformidade.
Como encontrar seu endpoint e credenciais
Cada Workspace tem sua própria URL de endpoint de auditoria e credenciais. Para encontrá-las:
-
Vá para Admin → Settings → Audit Export no seu Workspace.
-
Copie o Endpoint URL, a Client ID e a Secret Key.
Você pode regenerar ou revogar a Secret Key nesta página a qualquer momento. Ao regenerar uma chave, a anterior é invalidada imediatamente.
Autenticação
Toda requisição exige dois cabeçalhos personalizados:
Header |
Value |
|
O Client ID do seu Workspace |
|
A Secret Key do seu Workspace |
Obtendo eventos
GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}
Parâmetros de consulta
Parâmetro |
Obrigatório |
Descrição |
|
Não |
Posição inicial no conjunto de resultados. Padrão: |
|
Não |
Número máximo de eventos a retornar. Não pode exceder o máximo da API; excedê-lo retorna |
Exemplo com Curl
curl -G '{your-audit-endpoint}' \
-H 'ClientId: {your-client-id}' \
-H 'ClientSecret: {your-secret-key}' \
--data-urlencode 'Offset=0' \
--data-urlencode 'Limit=500'
Formato da resposta
{
"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"
}
}
]
}
Campos de nível superior
Campo |
Tipo |
Descrição |
|
integer |
Número total de eventos disponíveis em todas as páginas |
|
array |
Eventos na página atual |
Campos do evento
Campo |
Tipo |
Descrição |
|
string |
Versão do CEF |
|
string |
Sempre |
|
string |
Sempre |
|
string |
Sempre |
|
string |
Identificador da classe do evento |
|
string |
Nome do evento legível por humanos (por exemplo, |
|
object |
Dados detalhados do evento – veja abaixo |
Campos de extensão
Campo |
Tipo |
Descrição |
|
string |
Nome de domínio totalmente qualificado do Workspace |
|
string |
Descrição do evento legível por humanos |
|
string |
Timestamp do evento (ISO 8601) |
|
string |
Fuso horário (por exemplo, |
|
string |
Nome de usuário associado ao evento |
|
string |
Ação executada (por exemplo, |
|
string |
ID da entidade de origem |
|
string |
Categoria do evento (por exemplo, |
Paginação
Use TotalCount da primeira resposta para determinar quantas páginas buscar. Incremente Offset pelo seu Limit em cada requisição subsequente até que todos os eventos tenham sido recuperados.
Page 1: Offset=0, Limit=500 → events 1–500
Page 2: Offset=500, Limit=500 → events 501–1000
...
Códigos de status HTTP
Código |
Significado |
|
Eventos retornados com sucesso |
|
|
|
Credenciais inválidas ou licença Enterprise não ativa |
Leitura adicional
Audit Export no Altium 365 – configuração e setup do administrador do Workspace.