DocumentaciónExperience PlatformInformación general de Experience Platform

Extremo de eventos de auditoría

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Desarrollador
  • Usuario
  • Administrador
  • Líder

Los registros de auditoría se utilizan para proporcionar detalles de la actividad del usuario para varios servicios y funcionalidades. Cada acción registrada contiene metadatos que indican el tipo de acción, la fecha y la hora, el ID de correo electrónico del usuario que realizó la acción y los atributos adicionales relevantes de ese tipo de acción. El extremo /audit/events de la API Audit Query le permite recuperar mediante programación los datos de evento de la actividad de su organización en Platform.

Introducción

El extremo de API utilizado en esta guía forma parte de la Audit Query API. Antes de continuar, revisa la guía de introducción para ver vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier API de Experience Platform.

Enumerar eventos de auditoría

Puede recuperar datos de eventos realizando una solicitud de GET al extremo /audit/events, especificando los eventos que desea recuperar en la carga útil.

Formato de API

GET /audit/events

La API Audit Query admite el uso de parámetros de consulta para paginar y filtrar los resultados al enumerar eventos.

Parámetro
Descripción
limit
Número máximo de registros que se devolverán en la respuesta. El valor predeterminado limit es 50.
start
Un puntero al primer elemento para los resultados de búsqueda devueltos. Para acceder a la siguiente página de resultados, este parámetro debe incrementarse en la misma cantidad indicada por limit. Ejemplo: Para acceder a la siguiente página de resultados de una solicitud con límite=50, utilice el parámetro start=50, luego start=100 para la página siguiente, etc.
queryId
Al realizar una consulta al extremo /audit/events, la respuesta incluye una propiedad de cadena queryId. Para realizar la misma consulta en una llamada independiente, puede incluir el valor de ID como un único parámetro de consulta en lugar de volver a configurar manualmente los parámetros de búsqueda.

Solicitud

curl -X POST \
  https://platform.adobe.io/data/foundation/audit/events?limit=10
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'x-request-id: {TRACING_ID}' \

Respuesta

Una respuesta correcta devuelve los puntos de datos resultantes para las métricas y filtros especificados en la solicitud.

{
   "_embedded": {
     "customerAuditLogList": [
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "32b72208-3035-4bc6-b434-39e34401a864",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "5NphpgUQdQnjTWOcS9DSMs2wD1EUMlYG",
         "authId": "96715f98-d100-4575-8491-ebbcea654eb9",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T21:58:09.745+0000"
       },
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "a178736a-8fa1-47da-bac5-b0d9e741e414",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "7AlGIAhWvaEzYWHLzvuf26AAFAkqSyKg",
         "authId": "60fc1077-4aef-4e1f-a5ff-f64183e060f4",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T21:28:00.301+0000"
       },
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "ccfe8c77-9b93-481d-a561-0b2edf3b77dc",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "hArqS4CAa8wfRPnKuxV4yaA82atxwzYu",
         "authId": "80b7d887-9338-4cd5-9d79-2483b03f0160",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T20:58:07.750+0000"
       }
     ]
   },
   "_links": {
     "self": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?limit=10&start=0&property=type%253D%253Dcore"
     },
     "next": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&start=10&limit=10"
     },
     "page": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&limit=10{&start}",
       "templated": true
     }
  },
  "page": {
    "size": 10,
    "totalElements": 3,
    "totalPages": 1,
    "number": 1
  },
  "queryId": "cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2"
}
Propiedad
Descripción
customerAuditLogList
Una matriz cuyos objetos representen cada uno de los eventos especificados en la solicitud. Cada objeto contiene información sobre la configuración del filtro y los datos de evento devueltos.
userEmail
El correo electrónico del usuario que realizó el evento.
eventType
El tipo de evento. Los tipos de eventos incluyen Core y Enhanced.
imsOrgId
El ID de la organización en la que se produjo el evento.
permissionResource

El producto o la funcionalidad que proporcionó el permiso para realizar la acción. Un recurso puede ser cualquiera de los siguientes:

  • Activation
  • ActivationAssociation
  • AnalyticSource
  • AudienceManagerSource
  • BizibleSource
  • CustomerAttributeSource
  • Dataset
  • EnterpriseSource
  • LaunchSource
  • MarketoSource
  • ProductProfile
  • ProfileConfig
  • Sandbox
  • Schema
  • Segment
  • StreamingSource
permissionType
Tipo de permiso relacionado con la acción.
assetType
El tipo de recurso de plataforma en el que se realizó la acción.
assetId
Identificador único del recurso de plataforma en el que se realizó la acción.
assetName
Nombre del recurso de plataforma en el que se realizó la acción.
action

El tipo de acción que se registró para el evento. Una acción puede ser cualquiera de las siguientes:

  • Add
  • Create
  • Dataset activate
  • Dataset remove
  • Delete
  • Disable for profile
  • Enable
  • Enable for profile
  • Profile activate
  • Profile remove
  • remove
  • reset
  • segment activate
  • segment remove
  • update
status

El estado de la acción. Un estado puede ser cualquiera de los siguientes:

  • Allow

  • Deny

  • Failure

  • Success

recommendation-more-help
5741548a-2e07-44b3-9157-9c181502d0c5