Eventos de auditoría

Consultar eventos de auditoría

/api/v1/audit_events/query

Permisos necesarios: Leer registros de auditoría.

• Bash

  curl -X POST 'https://<my_api_endpoint>/api/v1/audit_events/query' \
      -H "Authorization: Bearer $REINFER_TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
    "filter": {
      "timestamp": {
        "maximum": "2021-07-10T00:00:00Z",
        "minimum": "2021-06-10T00:00:00Z"
      }
    }
  }'

• Nodo

  const request = require("request");
  
  request.post(
    {
      url: "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
      json: true,
      body: {
        filter: {
          timestamp: {
            maximum: "2021-07-10T00:00:00Z",
            minimum: "2021-06-10T00:00:00Z",
          },
        },
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.post(
      "https://<my_api_endpoint>/api/v1/audit_events/query",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
      json={
          "filter": {
              "timestamp": {
                  "minimum": "2021-06-10T00:00:00Z",
                  "maximum": "2021-07-10T00:00:00Z",
              }
          }
      },
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Respuesta

  {
    "audit_events": [
      {
        "actor_user_id": "e2148a6625225593",
        "dataset_ids": ["1fe230edc85ffc1a"],
        "event_id": "2555880060c23eb5",
        "event_type": "get_datasets",
        "project_ids": ["ce3c61dcf210f425", "274400867ab17af9"],
        "tenant_ids": ["c59b6e209da438a8"],
        "timestamp": "2021-06-10T16:32:53Z"
      }
    ],
    "continuation": "2555880060c23eb5",
    "datasets": [
      {
        "id": "1fe230edc85ffc1a",
        "name": "collateral-sharing",
        "project_id": "ce3c61dcf210f425",
        "title": "Collateral Sharing"
      },
      {
        "id": "274400867ab17af9",
        "name": "Customer-Feedback",
        "project_id": "ce3c61dcf210f425",
        "title": "Customer Feedback"
      }
    ],
    "projects": [
      {
        "id": "ce3c61dcf210f425",
        "name": "bank-collateral",
        "tenant_id": "c59b6e209da438a8"
      }
    ],
    "status": "ok",
    "tenants": [
      {
        "id": "c59b6e209da438a8",
        "name": "acme"
      }
    ],
    "users": [
      {
        "display_name": "Alice",
        "email": "[e-mail]",
        "id": "e2148a6625225593",
        "tenant_id": "c59b6e209da438a8",
        "username": "alice"
      }
    ]
  }

Un evento de auditoría es un registro de una acción realizada por un usuario de la plataforma Communications Mining. Ejemplos de eventos auditables incluyen:

• un usuario que inicia sesión
• un usuario que cambia su contraseña
• un usuario que cambia los permisos de otro usuario

Nombre	Tipo	Obligatorio	Descripción
continuation	String	No	Si una consulta anterior devolvió un continuation en la respuesta, hay otra página de eventos disponible. Establezca aquí el valor de continuación devuelto para obtener la página siguiente.
limit	Número	No	El número de eventos de auditoría que se devolverán por página. El valor predeterminado es 128.
filter	Filtro	No	Un filtro que especifica qué eventos de auditoría devolver.

Donde Filter tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
timestamp	FiltroDeMarcaDeHora	No	Un filtro que especifica en qué intervalo de tiempo devolver los eventos.

Donde TimestampFilter tiene el siguiente formato:

Nombre	Tipo	Obligatorio	Descripción
minimum	String	No	Una marca de tiempo ISO-8601. Si se proporciona, solo devuelve el evento de auditoría posterior o incluyendo esta marca de tiempo.
maximum	String	No	Una marca de tiempo ISO-8601. Si se proporciona, solo devuelve el evento de auditoría anterior a esta marca de tiempo.

Formato de respuesta

La lista de eventos de auditoría se puede encontrar bajo la clave audit_events en el nivel superior de la respuesta. Cada AuditEvent puede hacer referencia a otros recursos (como fuentes, conjuntos de datos, usuarios, etc.) por ID. Para cada recurso al que se hace referencia, se puede encontrar información adicional bajo la clave respectiva (sources, datasets, users, etc.) en el nivel superior de la respuesta.

Un AuditEvent representa una acción realizada por un usuario en la plataforma, y tiene el siguiente formato base. Pueden estar presentes claves adicionales dependiendo del valor de event_type. Por ejemplo, un evento de auditoría get_datasets tendrá una lista de dataset_ids que fueron leídos por el usuario.

Nombre	Tipo	Descripción
event_id	String	El ID único de este evento.
event_type	String	El tipo de este evento.
timestamp	String	La marca de tiempo ISO-8601 de este evento, redondeada al segundo más cercano.
actor_user_id	String	El ID del usuario que ejecutó esta acción.
actor_tenant_id	String	El ID de tenant del usuario que ejecutó esta acción.

Por último, si la respuesta contiene una clave continuation , debes obtener la siguiente página de eventos estableciendo el campo continuation en la solicitud con este valor.