Eventos de auditoria de API

Consulta de eventos de auditoria

Você pode consultar eventos de auditoria para recuperar um registro detalhado de ações do usuário e do sistema dentro da plataforma.

Observação:

Você deve ter atribuído a função Visualizador de logs de auditoria de IXP .

/api/v1/audit_events/query

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 que um usuário executa na plataforma de IXP. Exemplos de eventos auditáveis incluem:

• Um usuário que faz registro.
• Um usuário que altera sua senha.
• Um usuário que altera as permissões de outro usuário.

Name	Tipo	Required	Description
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 retornar.

filter tem o seguinte formato:

Name	Tipo	Required	Description
timestamp	FiltroDeCarimboDeHora	não	Um filtro que especifica em qual intervalo de tempo retornar eventos.

TimestampFilter tem o seguinte formato:

Name	Tipo	Required	Description
minimum	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, ele retorna apenas um evento de auditoria após ou incluindo este carimbo de data/hora.
maximum	String	não	Um carimbo de data/hora ISO-8601. Se fornecido, ele retorna apenas um evento de auditoria antes desse carimbo de data/hora.

Tipos de eventos de auditoria

Esta seção contém Todos os tipos de eventos de auditoria que se aplicam a Não estruturados e documentos complexos.

Gerenciamento do projeto

Tipo de Evento	Description
ucd_project_created	Um Projeto de Documentos Complexos e Não Estruturados é criado.
ucd_project_deleted	Um projeto de Documentos complexos e não estruturados é excluído.

Gerenciamento de modelos

Tipo de Evento	Description
model_version_published	Um modelo é publicado.
model_version_unpublished	Uma tag de modelo é atualizada.
model_tag_deleted	Um modelo publicado é excluído.

Gerenciamento de conjuntos de dados

Tipo de Evento	Description
get_datasets	Os conjuntos de dados são recuperados.
get_datasets_by_owner	Os conjuntos de dados são recuperados pelo proprietário.
get_dataset	Um conjunto de dados específico é recuperado.
export_dataset	Um conjunto de dados é exportado.

Gerenciamento do usuário

Tipo de Evento	Description
create_user	Um novo usuário é criado.
delete_user	Um usuário é excluído.
get_users	As informações do usuário são recuperadas.
update_user	As informações do usuário são modificadas.

Autenticação e segurança

Tipo de Evento	Description
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	Os tokens de API são revogados.
revoke_login_tokens	Os tokens de login são revogados.
revoke_current_login_token	O Token de sessão atual é revogado.
replace_api_token	O token de API é substituído.
authentication_failed_totp_lockout	Falha no login devido ao bloqueio TOTP.

Redefinição de senha

Tipo de Evento	Description
send_password_reset_success	Email de redefinição de senha bem-sucedido enviado.
send_password_reset_failed_ip_address	Redefinição de senha bloqueada por 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 por 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 por 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.

Consulta de comentário

Tipo de Evento	Description
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 Ordenar 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.

Anotações

Tipo de Evento	Description
get_annotations	As anotações são recuperadas.
update_annotation	Uma anotação é modificada.

Gerenciamento de cotas

Tipo de Evento	Description
quota_set	Uma cota é definida.
quota_reset	Uma cota foi redefinida.
quotas_get	As cotas são recuperadas.

Sistema e administração

Tipo de Evento	Description
audit_event_query	Os eventos de auditoria são consultados diretamente.