Eventos de auditoria

Eventos de auditoria de consulta

/api/v1/audit_events/query

Permissões necessárias: Ler logs de auditoria.

• 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"
      }
    }
  }'

• Nó

  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))

• Resposta

  {
    "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"
      }
    ]
  }

Um evento de auditoria é o registro de uma ação tomada por um usuário da plataforma Communications Mining. Exemplos de eventos auditáveis incluem:

• um usuário fazendo login
• um usuário alterando sua senha
• um usuário alterando as permissões de outro usuário

Nome	Tipo	Required	Descrição
continuation	String	não	Se uma consulta anterior retornar um continuation na resposta, outra página de eventos estará disponível. Defina o valor de continuação retornado aqui para buscar a próxima página.
limit	Número	não	O número de eventos de auditoria a serem retornados por página. O padrão é 128.
filter	Filtro	não	Um filtro que especifica quais eventos de auditoria serão retornados.

Onde Filter tem o seguinte formato:

Nome	Tipo	Required	Descrição
timestamp	FiltroDeCarimboDeHora	não	Um filtro que especifica o intervalo de tempo em que os eventos devem ser retornados.

Onde TimestampFilter tem o seguinte formato:

Nome	Tipo	Required	Descrição
minimum	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, retorna apenas evento de auditoria após ou incluindo esse carimbo de data/hora.
maximum	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, retorna apenas um evento de auditoria anterior a esse carimbo de data/hora.

Formato da resposta

A lista de eventos de auditoria pode ser encontrada na chave audit_events , no nível superior da resposta. Cada AuditEvent pode fazer referência a outros recursos (como origens, conjuntos de dados, usuários, etc.) por ID. Para cada recurso referenciado, informações adicionais podem ser encontradas na chave respectiva (sources, datasets, users etc) no nível superior da resposta.

Um AuditEvent representa uma ação realizada por um usuário na plataforma e tem o seguinte formato base. Chaves adicionais podem estar presentes, dependendo do valor de event_type. Por exemplo, um evento de auditoria get_datasets terá uma lista de dataset_ids que foram lidos pelo usuário.

Nome	Tipo	Descrição
event_id	String	O ID exclusivo deste evento.
event_type	String	O tipo deste evento.
timestamp	String	O carimbo de data/hora ISO-8601 deste evento, aproximado ao segundo.
actor_user_id	String	O ID do usuário que executou esta ação.
actor_tenant_id	String	O ID de tenant do usuário que executou esta ação.

Por fim, se a resposta contiver uma chave continuation , você deve buscar a próxima página de eventos definindo o campo continuation na solicitação para esse valor.