API-Prüfungsereignisse

Querying audit events

You can query audit events to retrieve a detailed record of user and system actions within the platform.

Note: You must have assigned the IXP Audit Log Viewer role.

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

Knoten

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

Antwort

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

An audit event is a record of an action a user takes in the IXP platform. Example auditable events include:

• A user logging in.
• A user changing their password.
• A user changing the permissions of another user.

Name	Typ	Erforderlich	Beschreibung
continuation	string	nein	Wenn eine vorherige Abfrage ein continuation in der Antwort zurückgegeben hat, ist eine andere Seite mit Ereignissen verfügbar. Legen Sie den zurückgegebenen Fortsetzungswert hier fest, um die nächste Seite abzurufen.
limit	Nummer	nein	Die Anzahl der Prüfungsereignisse, die pro Seite zurückgegeben werden sollen. Der Standardwert ist 128.
filter	Filter	nein	A filter that specifies which audit events to return.

filter hat das folgende Format:

Name	Typ	Erforderlich	Beschreibung
timestamp	Zeitstempelfilter	nein	A filter that specifies what time range to return events in.

TimestampFilter hat das folgende Format:

Name	Typ	Erforderlich	Beschreibung
minimum	string	nein	An ISO-8601 timestamp. If provided, it only returns an audit event after or including this timestamp.
maximum	string	nein	An ISO-8601 timestamp. If provided, it only returns an audit event before this timestamp.

Prüfungsereignistypen

Dieser Abschnitt enthält alle Prüfungsereignistypen, die für unstrukturierte und komplexe Dokumente gelten.

Projektmanagement

Ereignistyp	Beschreibung
ucd_project_created	Ein Projekt für unstrukturierte und komplexe Dokumente wird erstellt.
ucd_project_deleted	Ein Projekt für unstrukturierte und komplexe Dokumente wird gelöscht.

Modellverwaltung

Ereignistyp	Beschreibung
model_version_published	Ein Modell wird veröffentlicht.
model_version_unpublished	Ein Modell-Tag wird aktualisiert.
model_tag_deleted	Ein veröffentlichtes Modell wird gelöscht.

Dataset-Verwaltung

Ereignistyp	Beschreibung
get_datasets	Datasets werden abgerufen.
get_datasets_by_owner	Datasets werden vom Besitzer abgerufen.
get_dataset	Ein bestimmtes Dataset wird abgerufen.
export_dataset	Ein Dataset wird exportiert.

Protokolle

Ereignistyp	Beschreibung
create_user	Ein neuer Benutzer wird erstellt.
delete_user	Ein Benutzer wird gelöscht.
get_users	Benutzerinformationen werden abgerufen.
update_user	Benutzerinformationen werden geändert.

Authentifizierung und Sicherheit

Ereignistyp	Beschreibung
login_success	Erfolgreiche Benutzeranmeldung.
authentication_failed_password	Anmeldung aufgrund eines falschen Kennworts fehlgeschlagen.
authentication_failed_totp	Fehlgeschlagene Anmeldung aufgrund eines falschen TOTP-Codes.
login_failed_ip_address	Fehler bei der Anmeldung aufgrund von Einschränkungen für die IP-Adresse.
revoke_api_tokens	API-Token werden widerrufen.
revoke_login_tokens	Anmeldetoken werden widerrufen.
revoke_current_login_token	Das aktuelle Sitzungstoken wird widerrufen.
replace_api_token	API-Token wurde ersetzt.
authentication_failed_totp_lockout	Fehler bei der Anmeldung aufgrund einer TOTP-Sperre.

Kennwort zurücksetzen

Ereignistyp	Beschreibung
send_password_reset_success	E-Mail zum erfolgreichen Zurücksetzen des Kennworts gesendet.
send_password_reset_failed_ip_address	Zurücksetzen des Kennworts für IP-Blockierung.
verify_password_reset_success	Überprüfung des Zurücksetzens des Kennworts erfolgreich.
verify_password_reset_failed_ip_address	Verifizierung, dass das Zurücksetzen des Kennworts durch IP blockiert wurde.
change_password_success	Erfolgreiche Kennwortänderung.
change_password_failed_totp	Kennwortänderung aufgrund von TOTP fehlgeschlagen.
change_password_failed_ip_address	Kennwortänderung für IP blockiert.
verify_password_reset_failed_signature	Ungültige Signatur zum Zurücksetzen des Kennworts.
verify_password_reset_failed_timestamp	Abgelaufener Link zum Zurücksetzen des Kennworts.
change_password_failed_current_password	Falsches aktuelles Kennwort angegeben.

Kommentarabfrage

Ereignistyp	Beschreibung
comment_query_text	Textbasierte Kommentarabfragen.
comment_query_sample	Beispielkommentarabfragen.
comment_query_learning	Lernbezogene Kommentarabfragen.
comment_query_any_label_asc	Beschriftungsbasierte Abfragen in aufsteigender Reihenfolge.
comment_query_recent	Neueste Kommentarabfragen.
comment_query_by_label	Abfragen, die nach bestimmten Bezeichnungen gefiltert werden.
comment_query_diagnostic	Diagnosekommentarabfragen.
comment_query_label_property	Beschriftungseigenschaftsabfragen.
comment_query_attachment_text	Textabfragen für Anhänge.

Anmerkungen

Ereignistyp	Beschreibung
get_annotations	Anmerkungen werden abgerufen.
update_annotation	Eine Anmerkung wird geändert.

Kontingentverwaltung

Ereignistyp	Beschreibung
quota_set	Ein Kontingent wird festgelegt.
quota_reset	Ein Kontingent wird zurückgesetzt.
quotas_get	Kontingente werden abgerufen.

System und Verwaltung

Ereignistyp	Beschreibung
audit_event_query	Prüfungsereignisse werden direkt abgefragt.