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.

Enterprise license required. A opção Audit Export só aparece nas configurações de Administração do Workspace quando uma licença de nível Enterprise está ativa.

Como encontrar seu endpoint e credenciais

Cada Workspace tem sua própria URL de endpoint de auditoria e credenciais. Para encontrá-las:

  1. Vá para Admin → Settings → Audit Export no seu Workspace.

  2. 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

ClientId

O Client ID do seu Workspace

ClientSecret

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

Offset

Não

Posição inicial no conjunto de resultados. Padrão: 0

Limit

Não

Número máximo de eventos a retornar. Não pode exceder o máximo da API; excedê-lo retorna 400.

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

TotalCount

integer

Número total de eventos disponíveis em todas as páginas

Events

array

Eventos na página atual

Campos do evento

Campo

Tipo

Descrição

CefVersion

string

Versão do CEF

DeviceVendor

string

Sempre "Altium"

DeviceProduct

string

Sempre "365 Platform"

DeviceVersion

string

Sempre "Cloud"

DeviceEventClassId

string

Identificador da classe do evento

Name

string

Nome do evento legível por humanos (por exemplo, "User Login")

Extension

object

Dados detalhados do evento – veja abaixo

Campos de extensão

Campo

Tipo

Descrição

dvchost

string

Nome de domínio totalmente qualificado do Workspace

msg

string

Descrição do evento legível por humanos

rt

string

Timestamp do evento (ISO 8601)

dtz

string

Fuso horário (por exemplo, "UTC+00:00")

suser

string

Nome de usuário associado ao evento

act

string

Ação executada (por exemplo, "login", "create", "delete")

externalId

string

ID da entidade de origem

cat

string

Categoria do evento (por exemplo, "authentication", "design")

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

200 OK

Eventos retornados com sucesso

400 Bad Request

Limit excede o máximo da API

401 Unauthorized

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.

 

AI-LocalizedLocalizado por IA
Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.
Conteúdo