API ReferenceRegistros De Auditoria

Obter entradas de log de auditoria para um usuário especificado

Buscar logs de auditoria de um determinado usuário com alguns recursos de filtragem por parâmetros de consulta. Funciona melhor se você pensar nisso como um activity log do usuário especificado

Autenticação

AuthorizationBearer

Autenticação bearer na forma Bearer <token>, onde token é seu token de autenticação.

Parâmetros de caminho

user_idstringObrigatórioformat: "uuid"Padrão é erfb57e0-79f2-4bc7-9b70-99fbc175175c
User ID

Parâmetros de consulta

filters[start_date]stringOpcionalformat: "date"
Data ISO inicial
filters[end_date]stringOpcionalformat: "date"
Data ISO final
filters[resource_type]enumOpcional
Filtrar por tipo de recurso
filters[event_type]enumOpcional
Filtrar por tipo de atividade
filters[team_id]stringOpcionalformat: "uuid"
Filtrar por ID da equipe
filters[project_id]stringOpcionalformat: "uuid"
Filtrar por ID do projeto
filters[resource_id]stringOpcionalformat: "uuid"

Filtrar por ID do recurso (ID de ativo, ID de projeto, ID de usuário)

filters[user_id]stringOpcionalformat: "uuid"

Filtrar por ID de usuário

filters[ip_address]stringOpcional

Filtrar por endereço IP

pageintegerOpcionalPadrão é 1

Número da página

page_sizeintegerOpcional<=200Padrão é 50

Registros por página

Cabeçalhos de resposta

page-numberinteger
Current page of results
per-pageinteger
Number of entries per page
totalinteger
Total entries across all pagess
total-pagesinteger
Number of pages

Resposta

Succesful Event logs response
account_idstring or nullOpcionalformat: "uuid"
anonymous_user_idstring or nullOpcionalformat: "uuid"
clientstring or nullOpcional

O cliente de API que acionou o evento de auditoria. Esse campo nem sempre é preenchido.

Quando a chamada de API que gerou um evento é feita por um aplicativo OAuth, ela aparece como: oauth_app/:uuid; e, se for feita por um token de desenvolvedor, aparece como: user_token/:uuid, sendo o UUID o ID do usuário ao qual o token pertence.

Confira alguns exemplos:

  • user_token/57823879-e541-49b0-b902-c43794c4400c
  • oauth_app/80ccf0bb-ae91-49c4-8aec-8f6238c14947
  • web/2024-06-10-18-15
  • pipeline-media-warden/cbd0061f6f190489e8af3137b8707b33f498f53f
  • null
event_typeenumOpcional
event_detailsobjectOpcional

Os detalhes do evento. Isso varia bastante de um tipo de evento para outro, mas há alguns exemplos nas respostas de exemplo.

iddoubleOpcional
Identificador exclusivo
inserted_atstringOpcionalformat: "date-time"
ip_addressstring or nullOpcional

O endereço IP associado a este evento

project_idstring or nullOpcionalformat: "uuid"

O ID do projeto em que esta ação ocorreu

resource_idstringOpcionalformat: "uuid"
O ID do recurso referenciado
resource_typeenumOpcional
O tipo do recurso referenciado
team_idstring or nullOpcionalformat: "uuid"
ID da equipe
sourceenumOpcional

A origem da ação que produziu uma determinada entrada de log de auditoria

user_idstring or nullOpcionalformat: "uuid"

ID do usuário

updated_atstringOpcionalformat: "date-time"

Erros

401
Unauthorized Error
404
Not Found Error