Skip to main content

Ponto de extremidade Auditlog

Nota

Esta página de ajuda aborda o uso de um ponto de extremidade de API do Server. Para começar a usar a API do Server, consulte a Visão geral da API do Server.Visão geral da API

O Server monitora as alterações feitas nas seguintes entidades do sistema:

  • AppInfo (fluxo de trabalho)

  • Coleção

  • Credencial

  • Assinatura

  • Usuário

  • UserGroup (Grupo de usuários)

Obter eventos registrados pela API do Server

Qualquer atualização feita nessas entidades aciona a criação de um registro AuditEvent (evento de auditoria). Você pode retornar esses registros por meio de um ponto de extremidade público de API de administrador.

Os logs de auditoria são acionados pelos tipos de operações (eventos): Atualizar, Inserir e Excluir.

Ponto de extremidade

O ponto de extremidade para AuditEvents é GET /admin/v1/auditlog/

Parâmetros de consulta obrigatórios

  • entity: (string) a entidade do log de auditoria a ser consultada.

  • page: (int) a página a ser retornada.

  • pageSize: (int) o número de registros a serem retornados em cada página.

A resposta será uma série de registros de evento de auditoria:

[ { "id": "", "entity": "", "entityId": "", "userId": "", "timestamp": "Date", "event": "", "oldValues": "", "newValues": "" } ]

As propriedades retornadas estão definidas abaixo:

  • id: o ID do evento de auditoria.

  • entity: o nome da entidade.

  • entityId: o ID da entidade.

  • userId: o ID do usuário que modificou a entidade.

  • timestamp: a data/hora de criação do registro do evento de auditoria.

  • event: o evento que ocorreu (inserção, atualização, exclusão).

  • oldValues: os valores das propriedades antes da atualização.

  • newValues: os valores das propriedades depois da atualização.