API ReferenceRegistros De Auditoria

Obtener entradas del registro de auditoría para una cuenta

Recuperar registros de auditoría con algunas funciones de filtrado mediante parámetros de consulta

Autenticación

AuthorizationBearer

Autenticación de portador de la forma Bearer <token>, donde token es tu token de autenticación.

Parámetros de ruta

account_idstringRequeridoformat: "uuid"
Account ID

Parámetros de consulta

filters[start_date]stringOpcionalformat: "date"
Fecha ISO de inicio
filters[end_date]stringOpcionalformat: "date"

Fecha ISO de finalización

filters[resource_type]enumOpcional
Filtrar por tipo de activo
filters[event_type]enumOpcional
Filtrar por tipo de actividad
filters[team_id]stringOpcionalformat: "uuid"
Filtrar por ID de equipo
filters[project_id]stringOpcionalformat: "uuid"
Filtrar por ID de proyecto
filters[resource_id]stringOpcionalformat: "uuid"

Filtrar por ID de activo (ID de activo, ID de proyecto, ID de usuario)

filters[user_id]stringOpcionalformat: "uuid"
Filtrar por ID de usuario
filters[ip_address]stringOpcional

Filtrar por dirección IP

Compatible con IPv4 (1.1.1.1) e IPv6 (2001:db8:3333:4444:5555:6666:7777:8888)

pageintegerOpcionalValor predeterminado: 1

Número de página

page_sizeintegerOpcional<=200Valor predeterminado: 50

Registros por página

Encabezados de respuesta

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

Respuesta

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

El cliente de API que activó el evento de auditoría. No siempre se rellenará.

Cuando la llamada de API que generó un evento se realiza mediante una aplicación OAuth, tendrá este formato: oauth_app/:uuid, y si se realiza mediante un token de desarrollador, tendrá este formato: user_token/:uuid, donde el UUID es el ID de usuario al que pertenece el token.

A continuación, se muestran algunos ejemplos:

  • 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

Los detalles para el evento. Esto varía bastante de un tipo de evento a otro, pero hay algunos ejemplos en las respuestas de ejemplo.

iddoubleOpcional

Identificador único

inserted_atstringOpcionalformat: "date-time"
ip_addressstring or nullOpcional

La dirección IP asociada a este evento

project_idstring or nullOpcionalformat: "uuid"

El ID de proyecto en el que se produjo esta acción

resource_idstringOpcionalformat: "uuid"
El ID del activo referenciado
resource_typeenumOpcional
El tipo de activo referenciado
team_idstring or nullOpcionalformat: "uuid"
ID de equipo
sourceenumOpcional

La fuente de la acción que ha generado una entrada determinada del registro de auditoría

user_idstring or nullOpcionalformat: "uuid"
ID de usuario
updated_atstringOpcionalformat: "date-time"

Errores

401
Unauthorized Error
404
Not Found Error