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 é um registro de uma ação tomada por um usuário da plataforma Communications Mining™. Os exemplos de eventos auditáveis incluem:

• Um usuário fazendo logon
• 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. Consulte a lista de tipos de eventos na próxima seção.
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.

Tipos de evento de auditoria

Eventos de auditoria de alerta

Tipo de Evento	Descrição
alert_create	Um alerta será criado.
alert_get	Um alerta é exibido.
alert_get_all	Uma lista de alertas será exibida.
alert_update	A configuração de um alerta é editada.
alert_delete	Um alerta é excluído.
alert_subscriptions_get	Uma lista de assinaturas de alerta é exibida.
alert_subscriptions_delete	Uma assinatura de alerta é excluída.

Eventos de auditoria de cota

Tipo de Evento	Descrição
quotas_get	As cotas são visualizadas.
quotas_set	Uma cota é atualizada.
quotas_reset	Uma cota foi redefinida.

Eventos de auditoria de streams

Observação:

Anteriormente, os streams eram chamados de gatilhos.

Tipo de Evento	Descrição
trigger_create	Um fluxo é criado.
trigger_get	Um fluxo é visualizado.
trigger_get_all	Uma lista de transmissões é exibida.
trigger_update	A configuração de um stream é editada.
trigger_delete	Um stream é excluído.
trigger_fetch	Um stream é consultado (operação legada).
trigger_advance	Um stream é avançado.
trigger_reset	Um stream é redefinido.
trigger_fetch_gx	Um fluxo de extração generativo é consultado (operação legada).
trigger_get_results	Um stream é consultado.

Eventos de auditoria de gerenciamento de modelo

Tipo de Evento	Descrição
model_version_published	Quando um modelo é publicado (UCD) /fixado (CM).
model_version_unpublished	Quando um modelo publicado é excluído.
model_tag_updated	Quando uma tag de modelo é atualizada.
model_tag_deleted	Quando uma tag de modelo é removida.

Eventos de auditoria de gerenciamento de conjunto de dados

Tipo de Evento	Descrição
get_datasets	Quando os conjuntos de dados são recuperados.
get_datasets_by_owner	Quando os conjuntos de dados são recuperados pelo proprietário.
get_dataset	Quando um conjunto de dados específico é recuperado.
export_dataset	Quando um conjunto de dados é exportado.

Eventos de auditoria de gerenciamento de usuário

Tipo de Evento	Descrição
create_user	Quando um novo usuário é criado.
delete_user	Quando um usuário é excluído.
get_users	Quando as informações do usuário são recuperadas.
update_user	Quando as informações do usuário são modificadas.

Eventos de auditoria de autenticação e segurança

Tipo de Evento	Descrição
login_success	Login do usuário bem-sucedido.
authentication_failed_password	Falha no login devido a Senha errada.
authentication_failed_totp	Falha no login devido a código TOTP errado.
login_failed_ip_address	Falha no login devido a restrições de endereço IP.
revoke_api_tokens	Quando os tokens de API são revogados.
revoke_login_tokens	Quando os tokens de login são revogados.
revoke_current_login_token	Quando o token da sessão atual é revogado.
replace_api_token	Quando o token da API é substituído.
authentication_failed_totp_lockout	Falha no login devido ao bloqueio TOTP.

Eventos de auditoria de redefinição de senha

Tipo de Evento	Descrição
send_password_reset_success	Email de redefinição de senha bem-sucedido enviado.
send_password_reset_failed_ip_address	Redefinição de senha bloqueada pelo IP.
verify_password_reset_success	Verificação de redefinição de senha bem-sucedida.
verify_password_reset_failed_ip_address	Verificação de redefinição de senha bloqueada pelo IP.
change_password_success	Alteração de senha bem-sucedida.
change_password_failed_totp	Falha na alteração de senha devido ao TOTP.
change_password_failed_ip_address	Alteração de senha bloqueada pelo IP.
verify_password_reset_failed_signature	Assinatura de redefinição de senha inválida.
verify_password_reset_failed_timestamp	Link de redefinição de senha expirado.
change_password_failed_current_password	Senha atual incorreta fornecida.

Eventos de auditoria de consulta de comentário

Tipo de Evento	Descrição
comment_query_text	Consultas de comentários baseadas em texto.
comment_query_sample	Exemplos de consultas de Comentário.
comment_query_learning	Consultas de Comentário relacionadas ao aprendizado.
comment_query_any_label_asc	Consultas baseadas em rótulos (em ordem crescente).
comment_query_recent	Consultas de Comentários Recente.
comment_query_by_label	Consultas filtradas por Rótulos específicos.
comment_query_diagnostic	Consultas de comentários de diagnóstico.
comment_query_label_property	Consultas de propriedades de rótulo.
comment_query_attachment_text	Consultas de Texto de Anexo.
comment_query_check	Consultas de comentário do tipo verificação.
comment_query_missed	Consultas de comentários ausentes.

Eventos de auditoria de anotação

Tipo de Evento	Descrição
get_annotations	Quando as anotações são recuperadas.
update_annotation	Quando as anotações são modificadas.

Eventos de auditoria do sistema e do administrador

Tipo de Evento	Descrição
get_deprecated_user_models	Quando estão obsoletos, os modelos de usuário são acessados.
audit_event_query	Quando os próprios eventos de auditoria são consultados.
email_get	Quando os emails são recuperados.