Audit-Logging-Seite im Jitterbit Management Console

Übersicht

Einführung

Sie können die Protokolle der Benutzeraktivitäten in Harmony abrufen, die im Management Console, API Manager und Integration Studio stattfinden, sowie von externen Benutzern, die auf die Seite API-Portal zugreifen:

Als Alternative zur Anzeige von Audit-Protokollen auf dieser Seite können Sie Audit-Protokolle über eine REST-API abrufen. Die Audit-Log-Service-API wird weiter unten auf dieser Seite beschrieben.

Voraussetzungen

Um Audit-Protokolle zu aktivieren und anzuzeigen, müssen Sie Mitglied einer Rolle mit Admin Berechtigung in der Organisation sein.

Aktivieren der Audit-Protokollierung

Die Steuerung zum Aktivieren oder Deaktivieren der Audit-Protokollierung ist auf diesen beiden Seiten der Management Console synchronisiert:

• Diese Seite: Wählen Sie Audit-Logging Deaktiviert aus, um die Protokollierung zu aktivieren, oder Audit-Logging Aktiviert, um die Protokollierung für die [derzeit aktive Organisation] auszuschalten:

  

  

• [Organisations] Seite: Wählen Sie die entsprechende Organisation in der Tabelle aus. Im Organisationsrichtlinien-Bereich wählen Sie die Registerkarte API-Verwaltung und aktivieren oder deaktivieren Sie die Audit-Protokollierung, um die Audit-Protokollierung für die Organisation ein- oder auszuschalten.

Audit-Protokollierungsseitenkopf

Der Kopfbereich oben auf der Seite enthält eine Suchleiste und Filterikone, Datum- und Zeitfilter und zusätzliche Optionen:

Suchleiste

Um Protokolle zu filtern, verwenden Sie die Suchleiste:

Es gibt mehrere Möglichkeiten, die Suchleiste zu verwenden:

• Einzelne Filterauswahl: Klicken Sie in die leere Suchleiste, um eine Liste der folgenden auswählbaren Feldtypen und verfügbaren Werte für jedes zu öffnen:

  • Benutzername
  • Aktion
  • Umgebung

  Klicken Sie auf einen Feldwert, um die Protokolle nach diesem Feld zu filtern.

  Klicken Sie erneut auf die Suchleiste, um den Dialog zur Mehrfachfilterauswahl zu öffnen.

• Mehrfachfilterauswahl: Klicken Sie auf das Filter-Symbol, um den Dialog zur Mehrfachfilterauswahl zu öffnen:

  

  Sie können dies verwenden, um Protokolle nach einem oder mehreren der folgenden Schlüsselbereiche zu filtern:

  • Benutzername: Öffnen Sie das Menü und wählen Sie einen Benutzernamen aus.

  • Aktion: Öffnen Sie das Menü und wählen Sie eine der folgenden Aktionen aus:

    • Erstellen

    • Löschen

    • Abfragen

    • Aktualisieren

  • Aktivitätsinfo: Geben Sie eine Suchzeichenfolge ein.

  • Umgebung: Öffnen Sie das Menü und wählen Sie eine Umgebung aus.

  • Aktivitätsbeschreibung: Geben Sie eine Suchzeichenfolge ein.

Klicken Sie auf die Suche-Schaltfläche, um den Filter anzuwenden, oder auf Zurücksetzen, um den Filter zu entfernen.

• Filter-Syntax-Eingabe: Wenn die Suchleiste leer ist, können Sie Suchschlüssel und -werte direkt in die Suchleiste eingeben. Sie verfügt über eine Vorab-Funktion, die Ihnen verfügbare Begriffe und Werte vorschlägt.

  Wenn Sie die einzelnen und mehrere Filter verwenden, werden die entsprechenden Suchschlüssel und -werte in die Suchleiste eingegeben. Sie können die Abfrage so verwenden, wie sie ist, oder sie vor dem Absenden bearbeiten.

  Sie müssen jedes Suchschlüssel/Wert-Paar mit einem Semikolon beenden, und Sie können jeweils nur einen pro Abfrage verwenden. Die zulässigen Suchschlüssel und -werte sind wie folgt:

  • username=<USERNAME>, wobei <USERNAME> ein Harmony-Anmeldename ist.

  • action=<ACTION>, wobei <ACTION> eines von create, delete, query oder update ist.

  • activityInfo=<ACTIVITY_INFO>, wobei <ACTIVITY_INFO> eine beliebige Zeichenfolge ist, die in der Aktivitätsinfo-Spalte erscheint.

  • environmentName=<ENVIRONMENT_NAME>, wobei <ENVIRONMENT_NAME> ein gültiger Umgebungsname ist.

  • activity=<ACTIVITY>, wobei <ACTIVITY> eine beliebige Zeichenfolge ist, die in der Aktivitätsbeschreibung-Spalte erscheint.

  Beispiele

  Einzelbegriff-Abfrage: username

  username=example@jbexample.com;
  

  Einzelbegriff-Abfrage: action

  action=query;
  

  Einzelbegriff-Abfrage: environmentName

  environmentName=production;
  

  Einzelbegriff-Abfrage: activity

  activity=two factor;
  

  Einzelbegriff-Abfrage: activityInfo

  activityInfo=test;
  

  Mehrfachbegriff-Abfrage

  username=example@jbexample.com;action=Create;environmentName=Example Env A;activity=organization;
  

Datums- und Zeitfilter

Standardmäßig werden die Audit-Protokolldaten der letzten zwei Tage in der Audit-Protokolltabelle angezeigt.

Um den Zeitraum zu ändern, klicken Sie auf das Kalendersymbol in der Datumsbereichsleiste:

Ein Datumsauswahlfeld öffnet sich, in dem Sie das Start- und Enddatum für den Anzeigebereich festlegen können, entweder mit relativen oder absoluten Datumsbereichen:

Um den Zeitraum auf die Standardeinstellungen zurückzusetzen, klicken Sie auf das Rücksetzsymbol der Datumsbereichsleiste.

Die Spracheinstellungen Ihres Browsers bestimmen, wie Daten angezeigt werden.

Zusätzliche Optionen

Rechts von den Datum- und Zeitfiltern befinden sich die folgenden Steuerungen:

• Aktualisieren: Aktualisieren Sie die Tabellendaten.

• Spalteneinstellungen: Öffnen Sie die Spalteneinstellungs-Schublade:

  

  Verwenden Sie dies, um die Anordnung und Sichtbarkeit der Spalten zu ändern. Die Schublade hat die folgenden Steuerungen:

  • Alle anzeigen: Alle Spalten sichtbar machen.
  • Verschieben: Ziehen und Ablegen, um die Position der Spalte im Verhältnis zu anderen zu ändern.
  • Ausblenden: Die Spalte ist sichtbar. Klicken Sie, um sie auszublenden.
  • Anzeigen: Die Spalte ist ausgeblendet. Klicken Sie, um sie anzuzeigen.
  • Speichern: Spalten speichern.
  • Abbrechen: Schließen Sie die Spalten-Schublade, ohne Änderungen zu speichern.

• Herunterladen: Klicken Sie, um eine ZIP-Datei mit einer CSV-Datei der aktuellen Audit-Log-Daten basierend auf den angewendeten Filtern und Suchkriterien herunterzuladen.

Fußzeile der Audit-Logging-Seite

Wenn es mehr als 100 Operationen gibt, werden diese in Seiten von jeweils 100 aufgeteilt. Sie können durch sie navigieren, indem Sie diese Navigationsschaltflächen am Ende der Tabelle verwenden:

• Erste Seite: Gehen Sie zur ersten Seite.

• Vorherige Seite: Gehen Sie zur vorherigen Seite.

• Nächste Seite: Gehe zur nächsten Seite.

• Letzte Seite: Gehe zur letzten Seite.

Audit-Protokolle anzeigen

Jede Zeile in der Tabelle der Audit-Protokolle zeigt die Protokolldaten von Aktivitäten und Anmeldungen, die im Management Console, API Manager und Integration Studio stattfinden:

• Benutzername: Der Benutzername des Benutzers, der die Aktivität ausführt.

• Aktion: Die vom Benutzer durchgeführte Aktion, eine von Erstellen, Löschen, Aktualisieren oder Abfragen:

  • Erstellen: Zeigt an, dass der Benutzer neue Daten im Inhalt einer Seite im Management Console, einer API im API Manager oder eines Projekts im Integration Studio erstellt hat. Zum Beispiel wäre das Erstellen eines neuen Agents im Management Console oder das Bereitstellen eines Projekts im Integration Studio eine Erstellen-Aktion.

  • Löschen: Zeigt an, dass der Benutzer Daten aus dem Inhalt einer Seite im Management Console, einer API im API Manager oder eines Projekts im Integration Studio gelöscht hat. Zum Beispiel wäre das Löschen eines Agents im Management Console oder das Löschen eines Projekts aus dem Integration Studio eine Löschen-Aktion.

  • Aktualisieren: Zeigt an, dass der Benutzer den Inhalt einer Seite im Management Console, einer API im API Manager oder eines Projekts im Integration Studio aktualisiert hat. Zum Beispiel wäre das Ändern des Namens eines Agents im Management Console eine Aktualisieren-Aktion.

  • Abfragen: Zeigt an, dass der Benutzer den Inhalt einer Seite im Management Console, einer API im API Manager oder eines Projekts im Integration Studio angesehen hat. Zum Beispiel wäre das Anzeigen der Liste der Projekte im Integration Studio eine Abfragen-Aktion.

• Aktivitätsinfo: Wenn eine Bereitstellungsaktion erfolgt, zeigt diese Spalte die Namen des betroffenen Integration Studio-Projekts und der Operation an. Wenn ein Projekt bereitgestellt wird, wird der Name des Projekts angezeigt. Wenn eine einzelne Operation bereitgestellt wird, werden der Name des Projekts, das die Operation enthält, und der Name der Operation angezeigt. Wenn ein Sicherheitsprofil im API Manager hinzugefügt oder entfernt wird, wird die Änderung angezeigt. Wenn eine Benutzerrolle geändert wird, wird die Änderung angezeigt.

• Zeit: Der Zeitstempel der Aktivität. Zeiten werden in der Zeitzone Ihres Browsers angezeigt.

• Umgebungs-ID: Die ID der Umgebung oder der Umgebungen, in denen die Aktivität stattfindet.

• Umgebungsname: Der Name der Umgebung, in der die Aktivität stattfindet.

• Aktivitätsbeschreibung: Eine Beschreibung der Aktivität. Wenn keine Beschreibung verfügbar ist, wird die Endpunkt-URL angezeigt.

Audit-Log-Service-API

Als Alternative zur Anzeige von Audit-Logs auf der Management Console Audit Logging-Seite können Sie Audit-Logs über eine REST-API abrufen. Dies erfordert die Verwendung von Befehlszeilenwerkzeugen wie curl oder Anwendungen wie Postman.

Um die Audit Log Service API zu verwenden, nachdem Sie Audit Logging aktiviert haben für die Organisation (wie zuvor auf dieser Seite beschrieben), befolgen Sie diese Schritte:

1. Abrufen eines Authentifizierungstokens über die User Service Controller API. Dieses Token ist erforderlich, um die Audit Log Service API zu verwenden.

   • Wenn Ihre Harmony Organisation keine Zwei-Faktor-Authentifizierung (TFA) aktiviert hat, holen Sie Ihr Authentifizierungstoken mit einer Standard-Anmeldeanforderung.

   • Wenn Ihre Harmony Organisation TFA aktiviert hat, erfordert das Abrufen des Authentifizierungstokens zwei Anfragen:

     1. Holen Sie sich einen TFA-Code

     2. Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

2. Protokolle abrufen über die Audit Log Service API.

Authentifizierungstoken abrufen

Das Abrufen eines Authentifizierungstokens erfordert die Verwendung der User Service Controller API.

Ein Beispiel für eine Anfrage, die das Anmelden in der NA-Region und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Körperparameter

Diese erforderlichen Parameter werden im Körper der Anfrage übergeben:

Antwortkörper

Der zurückgegebene Antwortkörper enthält eine Liste der Organisationen, mit denen der Benutzer verbunden ist, zusätzlich zum Authentifizierungstoken ("authenticationToken"). Dieses Token ist für die nachfolgende Autorisierung mit der Audit Logging API erforderlich. In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4". Die Organisations-ID wird als "123456" für die erste Organisation angezeigt, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "20970",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Abrufen eines Authentifizierungstokens mit aktivierter TFA

Wenn die Organisation eines Benutzers in Harmony die Zwei-Faktor-Authentifizierung (TFA) aktiviert hat, erfordert das Abrufen des Authentifizierungstokens zwei Anfragen über die User Service Controller API:

1. TFA-Code abrufen

2. TFA-Code verwenden, um ein Authentifizierungstoken abzurufen

TFA-Code abrufen

Ein gültiger TFA-Code ist erforderlich, um ein Authentifizierungstoken abzurufen, wenn TFA aktiviert ist. Ein Beispiel für eine Anfrage, die das Anmelden in der NA-Region und das Anfordern eines TFA-Codes zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "deviceId": "abcd"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Körperparameter

Diese erforderlichen Parameter werden im Körper der Anfrage übergeben:

Antwortkörper

Der zurückgegebene Antwortkörper enthält eine Fehlermeldung, die angibt, dass ein TFA-Code an die E-Mail-Adresse des Benutzers gesendet wurde.

{
  "status": false,
  "operation": "User login",
  "errorCode": "VALIDATE_TFA_LOGIN_EMAIL",
  "errorMessage": "Validate your login with authentication code. An email from Jitterbit with the code was sent to you.",
  "authenticationToken": null,
  "serverUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [],
  "defaultOrgId": null
}

Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

Der an die E-Mail-Adresse des Benutzers gesendete TFA-Code kann nun in der zweiten Anfrage verwendet werden, um das Authentifizierungstoken abzurufen. Eine Beispielanfrage, die das Anmelden in der NA-Region mit einem TFA-Code und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login/tfacode' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "code": "112233",
    "deviceId": "abcd"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Körperparameter

Diese erforderlichen Parameter werden im Körper der Anfrage übergeben:

Antwortkörper

Der zurückgegebene Antwortkörper enthält eine Liste der Organisationen, mit denen der Benutzer verbunden ist, zusätzlich zum Authentifizierungstoken ("authenticationToken"). Dieses Token ist für die nachfolgende Autorisierung mit der Audit Logging API erforderlich. In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4". Die Organisations-ID wird als "123456" für die erste Organisation angezeigt, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "654321",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Abrufen von Auditprotokollen

Sobald Sie das Authentifizierungstoken, die Organisations-ID und einen interessierenden Zeitraum haben, können Sie Auditprotokolle abrufen. Ein Beispiel, das das Abrufen aller Datensätze ab dem 1. Januar 2021 zeigt und die detaillierte Version der Datensätze enthält:

curl --request POST 'https://api.na.jitterbit.com/v1/auditlog?detail=true' \
--header 'accept: application/json' \
--header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "queryParams": {
        "organization_id": "123456"
    },
    "range": {
        "fromTimestamp": "2021-01-01T00:00:00.000Z",
        "toTimeStamp": "9999-01-01T00:00:00.000Z"
    }
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Endpunkte

Der Audit Log Service hat diese Endpunkte (APIs) verfügbar:

URL-Parameter

Diese Parameter können in der URL übergeben werden:

Header

Diese Header können in der Anfrage verwendet werden:

Body-Parameter

Diese Parameter können im Body der Anfrage übergeben werden:

Beispiel

Dieses Beispiel verwendet den auditlog/download Endpunkt, um alle Datensätze für die Organisation 123456 abzurufen, mit einer Aktion von QUERY, beginnend ab dem 1. Januar 2023, einschließlich der detaillierten Version der Datensätze, und heruntergeladen als CSV im komprimierten (ZIP) Dateiformat in eine Ausgabedatei:

curl --request POST 'https://api.na.jitterbit.com/v1/auditlog/download?detail=true' \
--output 'download.zip' \
--header 'accept: application/zip' \
--header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "queryParams": {
        "organization_id": "123456",
        "action": "QUERY"
    },
    "range": {
        "fromTimestamp": "2023-01-01T00:00:00.000Z",
        "toTimeStamp": "9999-01-01T00:00:00.000Z"
    }
}'

Beispielprotokollausgabe

Dies ist ein Beispielfragment der JSON-Ausgabe, die vom auditlog Endpunkt zurückgegeben wird:

{
  "records": [
    {
      "username": "alice@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/user/login",
      "action": "UPDATE",
      "action_timestamp": "2023-03-23T09:59:59.999Z",
      "environment_ids": null,
      "environment_names": null,
      "sort_values": [
        1680083968484
      ],
      "user_id": null,
      "acitivity_info": null,
      "request_body": "null",
      "response_body": "null"
    },
    {
      "username": "bob@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/subscription/list/647330",
      "action": "QUERY",
      "action_timestamp": "2023-03-23T08:59:59.999Z",
      "environment_ids": null,
      "environment_names": null,
      "sort_values": [
          1680081692921
      ],
      "user_id": null,
      "acitivity_info": null,
      "request_body": "null",
      "response_body": "{\"subscriptions\":[{\"organizationId\":\"123321\",\"lastUpdatedBy\":\"alice@jbexample.com\",\"offeringName\":\"Jitterbit Harmony Enterprise\",\"activatedOn\":1658343482577,\"createdBy\":\"alice@jbexample.com\",\"displayExpiresOn\":1660934256000,\"lastUpdatedOn\":1658343482660,\"expiresOn\":2607705456000,\"id\":\"125521\",\"createdOn\":1658343482577,\"offeringEnumId\":\"5\"}],\"operation\":\"List Subscription by Organization\",\"status\":true}"
    },
    {
      "username": "bob@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/project/env/detail/654321",
      "action": "CREATE",
      "action_timestamp": "2023-03-23T07:59:59.999Z",
      "environment_ids": [
          "654321"
      ],
      "environment_names": [
          "Default Environment"
      ],
      "sort_values": [
          1679393229672
      ],
      "user_id": null,
      "acitivity_info": "Project: Salesforce to NetSuite Operation: Get Customers",
      "request_body": "null",
      "response_body": "{\"projEnvDetails\":{\"noOfConnections\":0,\"lastUpdatedBy\":\"alice@jbexample.com\",\"agentClusterId\":1,\"noOfHostedEndPoints\":0,\"appRuntime\":\"sandbox\",\"agentGroupId\":\"99999\",\"urlPrefix\":\"defaultUrlPrefix\",\"permission\":7,\"envId\":\"654321\",\"agentGroupName\":\"Production Cloud Agent Group\",\"lowestAgentVersion\":\"11.0.0.0\",\"createdOn\":1515425638817,\"orgId\":\"123456\",\"noOfScripts\":0,\"noOfProjects\":0,\"createdBy\":\"bob@jbexample.com\",\"envName\":\"Default Environment\",\"envType\":2,\"noOfFileFormats\":0,\"envDesc\":\"Default environment created by Harmony\",\"lastUpdatedOn\":1661335689017,\"noOfOperations\":0},\"operation\":\"Get detail of a Project Env\",\"status\":true}"
    },
. . .
  ]
}