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™. Los ejemplos de eventos auditables incluyen:

• Un usuario iniciando 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. Consulta la lista de tipos de eventos en la siguiente sección.
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.

Tipos de eventos de auditoría

Eventos de auditoría de alerta

Tipo de evento	Descripción
alert_create	Se crea una alerta.
alert_get	Se ve una alerta.
alert_get_all	Se visualiza una lista de alertas.
alert_update	Se edita la configuración de una alerta.
alert_delete	Se elimina una alerta.
alert_subscriptions_get	Se visualiza una lista de suscripciones a alertas.
alert_subscriptions_delete	Se elimina una suscripción de alerta.

Eventos de auditoría de cuota

Tipo de evento	Descripción
quotas_get	Se ven las cuotas.
quotas_set	Se actualiza una cuota.
quotas_reset	Se restablece una cuota.

Transmite eventos de auditoría

Nota:

Las transmisiones se llamaban anteriormente desencadenadores.

Tipo de evento	Descripción
trigger_create	Se crea una transmisión.
trigger_get	Se ve una transmisión.
trigger_get_all	Se visualiza una lista de transmisiones.
trigger_update	Se edita la configuración de una transmisión.
trigger_delete	Se ha eliminado una transmisión.
trigger_fetch	Se consulta una transmisión (operación heredada).
trigger_advance	Se avanza una transmisión.
trigger_reset	Se restablece una transmisión.
trigger_fetch_gx	Se consulta una secuencia de extracción generativa (operación heredada).
trigger_get_results	Se consulta una transmisión.

Eventos de auditoría de gestión de modelos

Tipo de evento	Descripción
model_version_published	Cuando se publica un modelo (UCD)/anclado (CM).
model_version_unpublished	Cuando se elimina un modelo publicado.
model_tag_updated	Cuando se actualiza una etiqueta de modelo.
model_tag_deleted	Cuando se elimina una etiqueta de modelo.

Eventos de auditoría de gestión de conjuntos de datos

Tipo de evento	Descripción
get_datasets	Cuando se recuperan los conjuntos de datos.
get_datasets_by_owner	Cuando los conjuntos de datos son recuperados por el propietario.
get_dataset	Cuando se recupera un conjunto de datos específico.
export_dataset	Cuando se exporta un conjunto de datos.

Eventos de auditoría de gestión de usuarios

Tipo de evento	Descripción
create_user	Cuando se crea un nuevo usuario.
delete_user	Cuando se elimina un usuario.
get_users	Cuando se recupera la información del usuario.
update_user	Cuando se modifica la información del usuario.

Eventos de autenticación y auditoría de seguridad

Tipo de evento	Descripción
login_success	Inicio de sesión exitoso del usuario.
authentication_failed_password	Error de inicio de sesión debido a una Contraseña incorrecta.
authentication_failed_totp	Error de inicio de sesión debido a un código TOTP incorrecto.
login_failed_ip_address	Error de inicio de sesión debido a restricciones de la dirección IP.
revoke_api_tokens	Cuando se revocan los tokens de API.
revoke_login_tokens	Cuando se revocan los tokens de inicio de sesión.
revoke_current_login_token	Cuando se revoca el token de sesión actual.
replace_api_token	Cuando se reemplaza el token de API.
authentication_failed_totp_lockout	Error de inicio de sesión debido al bloqueo de TOTP.

Eventos de auditoría de restablecimiento de contraseña

Tipo de evento	Descripción
send_password_reset_success	Se ha enviado un correo electrónico para restablecer la contraseña.
send_password_reset_failed_ip_address	Restablecimiento de contraseña bloqueado por IP.
verify_password_reset_success	Verificación de restablecimiento de contraseñas correcta.
verify_password_reset_failed_ip_address	Verificación de restablecimiento de contraseña bloqueada por IP.
change_password_success	Cambio de contraseña correcto.
change_password_failed_totp	El cambio de contraseña falló debido a TOTP.
change_password_failed_ip_address	Cambio de contraseña bloqueado por IP.
verify_password_reset_failed_signature	Firma de restablecimiento de contraseña no válida.
verify_password_reset_failed_timestamp	Enlace de restablecimiento de contraseña caducado.
change_password_failed_current_password	Se ha proporcionado una contraseña actual incorrecta.

Eventos de auditoría de consulta de comentarios

Tipo de evento	Descripción
comment_query_text	Consultas de comentarios basadas en texto.
comment_query_sample	Ejemplo de consultas de comentarios.
comment_query_learning	Consultas de comentarios relacionadas con el aprendizaje.
comment_query_any_label_asc	Consultas basadas en etiquetas (ascendente).
comment_query_recent	Consultas de comentarios recientes.
comment_query_by_label	Consultas filtradas por etiquetas específicas.
comment_query_diagnostic	Consultas de comentarios de diagnóstico.
comment_query_label_property	Consultas de propiedades de etiquetas.
comment_query_attachment_text	Consultas de texto de archivo adjunto.
comment_query_check	Consultas de comentarios de tipo comprobación.
comment_query_missed	Consultas de comentarios perdidas.

Eventos de auditoría de anotación

Tipo de evento	Descripción
get_annotations	Cuando se recuperan las anotaciones.
update_annotation	Cuando se modifican las anotaciones.

Eventos de auditoría del sistema y del administrador

Tipo de evento	Descripción
get_deprecated_user_models	Cuando se accede a modelos de usuario obsoletos.
audit_event_query	Cuando se consultan los propios eventos de auditoría.
email_get	Cuando se recuperan los correos electrónicos.