Prüfungsereignisse

Abfrage-Prüfungsereignisse

/api/v1/audit_events/query

Erforderliche Berechtigungen: Prüfungsprotokolle lesen.

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

Ein Prüfungsereignis ist eine Aufzeichnung einer Aktion, die von einem Benutzer der Communications Mining™-Plattform durchgeführt wird. Beispiele für prüfungsfähige Ereignisse:

• Ein Benutzer, der sich anmeldet
• Ein Benutzer, der sein Kennwort ändert
• Ein Benutzer, der die Berechtigungen eines anderen Benutzers ändert.

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	Ein Filter, der angibt, welche Prüfungsereignisse zurückgegeben werden sollen.

Dabei hat Filter das folgende Format:

Name	Typ	Erforderlich	BESCHREIBUNG
timestamp	Zeitstempelfilter	nein	Ein Filter, der angibt, in welchem Zeitbereich Ereignisse zurückgegeben werden sollen.

Dabei hat TimestampFilter das folgende Format:

Name	Typ	Erforderlich	BESCHREIBUNG
minimum	string	nein	Ein ISO-8601-Zeitstempel. Wenn angegeben, wird nur ein Prüfungsereignis nach oder einschließlich dieses Zeitstempels zurückgegeben.
maximum	string	nein	Ein ISO-8601-Zeitstempel. Wenn angegeben, wird nur ein Prüfungsereignis vor diesem Zeitstempel zurückgegeben.

Antwortformat

Die Liste der Prüfungsereignisse finden Sie unter dem Schlüssel audit_events auf der obersten Ebene der Antwort. Jeder AuditEvent kann anhand der ID auf andere Ressourcen verweisen (z. B. Quellen, Datasets, Benutzer usw.). Für jede referenzierte Ressource finden Sie zusätzliche Informationen unter dem jeweiligen Schlüssel (sources, datasets, users usw.) auf der obersten Ebene der Antwort.

Ein AuditEvent stellt eine Aktion dar, die von einem Benutzer auf der Plattform ausgeführt wird, und hat das folgende Grundformat. Je nach Wert von event_type können zusätzliche Schlüssel vorhanden sein. Beispielsweise enthält ein get_datasets -Prüfungsereignis eine Liste von dataset_ids , die vom Benutzer gelesen wurden.

Name	Typ	BESCHREIBUNG
event_id	string	Die eindeutige ID dieses Termins.
event_type	string	Der Typ dieses Termins. Bitte beachten Sie die Liste der Ereignistypen im nächsten Abschnitt.
timestamp	string	Der ISO-8601-Zeitstempel dieses Ereignisses auf die nächste Sekunde genau.
actor_user_id	string	Die ID des Benutzers, der diese Aktion ausgeführt hat.
actor_tenant_id	string	Die Mandanten-ID des Benutzers, der diese Aktion ausgeführt hat.

Wenn die Antwort schließlich einen continuation -Schlüssel enthält, sollten Sie die nächste Seite der Ereignisse abrufen, indem Sie das Feld continuation in der Anforderung auf diesen Wert festlegen.

Prüfungsereignistypen

Warnungsprüfungsereignisse

Ereignistyp	BESCHREIBUNG
alert_create	Eine Warnung wird erstellt.
alert_get	Eine Warnung wird angezeigt.
alert_get_all	Eine Liste mit Warnungen wird angezeigt.
alert_update	Die Konfiguration einer Warnung wird bearbeitet.
alert_delete	Eine Warnung wird gelöscht.
alert_subscriptions_get	Eine Liste der Warnungsabonnements wird angezeigt.
alert_subscriptions_delete	Ein Warnungsabonnement wird gelöscht.

Kontingentprüfungsereignisse

Ereignistyp	BESCHREIBUNG
quotas_get	Kontingente werden angezeigt.
quotas_set	Ein Kontingent wird aktualisiert.
quotas_reset	Ein Kontingent wird zurückgesetzt.

Streamet Prüfungsereignisse

Hinweis:

Streams wurden früher als Trigger bezeichnet.

Ereignistyp	BESCHREIBUNG
trigger_create	Ein Stream wird erstellt.
trigger_get	Ein Stream wird angezeigt.
trigger_get_all	Eine Liste der Streams wird angezeigt.
trigger_update	Die Konfiguration eines Streams wird bearbeitet.
trigger_delete	Ein Stream wird gelöscht.
trigger_fetch	Ein Stream wird abgefragt (Legacy-Vorgang).
trigger_advance	Ein Stream wird erweitert.
trigger_reset	Ein Stream wird zurückgesetzt.
trigger_fetch_gx	Ein generativer Extraktionsstream wird abgefragt (Legacy-Vorgang).
trigger_get_results	Ein Stream wird abgefragt.

Prüfungsereignisse für die Modellverwaltung

Ereignistyp	BESCHREIBUNG
model_version_published	Wenn ein Modell veröffentlicht (UCD)/angeheftet (CM) wird.
model_version_unpublished	Wenn ein veröffentlichtes Modell gelöscht wird.
model_tag_updated	Wenn ein Modell-Tag aktualisiert wird.
model_tag_deleted	Wenn ein Modell-Tag entfernt wird.

Prüfungsereignisse für die Dataset-Verwaltung

Ereignistyp	BESCHREIBUNG
get_datasets	Wenn Datasets abgerufen werden.
get_datasets_by_owner	Wenn Datasets vom Besitzer abgerufen werden.
get_dataset	Wenn ein bestimmtes Dataset abgerufen wird.
export_dataset	Wenn ein Dataset exportiert wird.

Prüfungsereignisse für die Benutzerverwaltung

Ereignistyp	BESCHREIBUNG
create_user	Wenn ein neuer Benutzer erstellt wird.
delete_user	Wenn ein Benutzer gelöscht wird.
get_users	Wenn Benutzerinformationen abgerufen werden.
update_user	Wenn Benutzerinformationen geändert werden.

Authentifizierungs- und Sicherheitsprüfungsereignisse

Ereignistyp	BESCHREIBUNG
login_success	Erfolgreiche Benutzeranmeldung.
authentication_failed_password	Anmeldung aufgrund eines falschen Kennworts fehlgeschlagen.
authentication_failed_totp	Anmeldung aufgrund eines falschen TOTP-Codes fehlgeschlagen.
login_failed_ip_address	Anmeldung fehlgeschlagen aufgrund von IP-Adressbeschränkungen.
revoke_api_tokens	Wenn API-Token widerrufen werden.
revoke_login_tokens	Wenn Anmeldetoken widerrufen werden.
revoke_current_login_token	Wenn das aktuelle Sitzungstoken widerrufen wird.
replace_api_token	Wenn das API-Token ersetzt wird.
authentication_failed_totp_lockout	Fehlgeschlagene Anmeldung aufgrund einer TOTP-Sperre.

Prüfungsereignisse zum Zurücksetzen des Kennworts

Ereignistyp	BESCHREIBUNG
send_password_reset_success	Erfolgreiche E-Mail zum Zurücksetzen des Kennworts gesendet.
send_password_reset_failed_ip_address	Zurücksetzen des Kennworts durch IP blockiert.
verify_password_reset_success	Erfolgreiche Verifizierung der Passwortzurücksetzung.
verify_password_reset_failed_ip_address	Verifizierung des Zurücksetzens des Kennworts durch IP blockiert.
change_password_success	Erfolgreiche Kennwortänderung.
change_password_failed_totp	Die Kennwortänderung ist aufgrund von TOTP fehlgeschlagen.
change_password_failed_ip_address	Kennwortänderung durch 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.

Prüfungsereignisse für Kommentarabfragen

Ereignistyp	BESCHREIBUNG
comment_query_text	Textbasierte Kommentarabfragen.
comment_query_sample	Beispielkommentarabfragen.
comment_query_learning	Lernbezogene Kommentaranfragen.
comment_query_any_label_asc	Beschriftungsbasierte Abfragen (aufsteigend).
comment_query_recent	Aktuelle Kommentarabfragen.
comment_query_by_label	Abfragen nach bestimmten Labels gefiltert.
comment_query_diagnostic	Diagnose-Kommentarabfragen.
comment_query_label_property	Abfragen zu Label-Eigenschaften.
comment_query_attachment_text	Anhangstextabfragen.
comment_query_check	Kommentarabfragen vom Typ Check.
comment_query_missed	Fehlende Kommentarabfragen.

Prüfungsereignisse mit Anmerkungen

Ereignistyp	BESCHREIBUNG
get_annotations	Wenn Anmerkungen abgerufen werden.
update_annotation	Wenn Anmerkungen geändert werden.

System- und Administratorprüfungsereignisse

Ereignistyp	BESCHREIBUNG
get_deprecated_user_models	Wenn auf veraltete Benutzermodelle zugegriffen wird.
audit_event_query	Wenn Prüfungsereignisse selbst abgefragt werden.
email_get	Wenn E-Mails abgerufen werden.