Seite „Audit-Logging“ in der Jitterbit-Management Console

Einführung

Auf der Seite Audit-Protokollierung der Management Console können Harmony-Organisationsadministratoren Protokolle der Harmony Benutzeraktivität abrufen, die in der Management Console stattfinden, API-Manager, Und Integration Studio und externe Benutzer Zugriff auf das API-Manager Portal Seite.

Um auf die Seite zuzugreifen, melden Sie sich beim Harmony-Portal an, verwenden Sie dann das Harmony-Portalmenü oben links und navigieren Sie zu Management Console > Audit-Protokollierung:

Als Alternative zur Anzeige von Audit-Protokollen auf dieser Seite können Sie Audit-Protokolle auch ü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 Überwachungsprotokollierung

Die Steuerung zum Aktivieren oder Deaktivieren der Überwachungsprotokollierung wird über diese beiden Seiten der Management Console hinweg synchronisiert:

• Diese Seite: Wählen Sie Audit Logging Disabled, um das Audit Logging einzuschalten oder Audit Logging Enabled, um das Audit Logging für das currently active organization:

  

  

• Organizations Seite: Wählen Sie die entsprechende Organisation in der Tabelle aus. Wählen Sie in der Tab API Verwaltung und dann Auditprotokollierung aktivieren aus, um die Auditprotokollierung für die Organisation ein- oder auszuschalten.

Header der Audit-Protokollierungsseite

Die Header oben auf der Seite enthält eine Suchleiste, Datums- und Uhrzeitfilter sowie zusätzliche Optionen:

Suchleiste

Mit der Suchleiste können Sie die Protokolle nach den unten angegebenen Suchkriterien filtern:

Suchkriterien

Dies sind Beispiele für die Suchkriterien, die verwendet werden können:

Suchen kombinieren

Suchen können eine Kombination von Kriterien enthalten. Kombinierte Suchkriterien müssen durch ein Semikolon (;) zwischen jedem Kriterium. Dies sind Beispiele für gültige kombinierte Suchen:

action=update;environment=production

environmentid=123456;action=create

Datums- und Uhrzeitfilter

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

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

Es öffnet sich ein Datumswähler, in dem Sie das Start- und Enddatum für den Anzeigezeitraum festlegen können:

Um den Zeitraum auf den Standardwert zurückzusetzen, klicken Sie auf die Datumsbereichsleiste Symbol zurücksetzen.

Zusätzliche Optionen

Rechts neben den Datums- und Zeitfiltern befinden sich die folgenden Steuerelemente:

• Aktualisieren: Aktualisieren Sie die Tabellendaten.

• Spalteneinstellungen: Öffnen Sie die Schublade mit den Spalteneinstellungen:

  

  Verwenden Sie dies, um die Anordnung und Sichtbarkeit von Spalten zu ändern. Die Schublade verfügt über die folgenden Steuerelemente:

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

• Download: Klicken Sie hier, um eine ZIP-Datei herunterzuladen, die eine CSV-Datei mit den aktuellen Prüfprotokolldaten basierend auf den angewendeten Filtern und Suchkriterien enthält.

Fußzeile der Audit-Protokollierungsseite

Wenn mehr als 100 Vorgänge vorhanden sind, werden sie auf Seiten mit jeweils 100 Vorgängen aufgeteilt. Sie können sie mithilfe dieser Navigationsschaltflächen am unteren Ende der Tabelle durchgehen:

• Erste Seite: Gehe zur ersten Seite.

• Vorherige Seite: Zur vorherigen Seite gehen.

• Nächste Seite: Zur nächsten Seite gehen.

• Letzte Seite: Zur letzten Seite gehen.

Anzeigen von Überwachungsprotokollen

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

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

• Aktion: Die vom Benutzer ausgeführte Aktion, eine der folgenden Optionen: Erstellen, Löschen, Aktualisieren oder Abfragen:

  • Erstellen: Zeigt an, dass der Benutzer neue Daten im Inhalt einer Seite in der Management Console, einer API im API-Manager oder eines Projekts in erstellt hat. Integration Studio. Beispielsweise das Erstellen eines neuen Agenten in der Management Console oder das Bereitstellen eines Projekts in Integration Studio wären Erstellen-Aktionen.

  • Löschen: Zeigt an, dass der Benutzer Daten aus dem Inhalt einer Seite in der Management Console, einer API im API-Manager oder eines Projekts in Integration Studio. Beispielsweise das Löschen eines Agenten in der Management Console oder das Löschen eines Projekts aus Integration Studio wären Löschaktionen.

  • Update: Zeigt an, dass der Benutzer den Inhalt einer Seite in der Management Console, einer API im API-Manager oder eines Projekts in Integration Studio. Das Ändern des Namens eines Agenten in der Management Console wäre beispielsweise eine Update-Aktion.

  • Abfrage: Gibt an, dass der Benutzer den Inhalt einer Seite in der Management Console, einer API im API-Manager oder eines Projekts in Integration Studio. Wenn Sie beispielsweise die Liste der Projekte in Integration Studio wäre eine Abfrage-Aktion.

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

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

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

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

• Jitterbit Endpoint URL: Eine Beschreibung des Endpoint. Wenn keine Beschreibung verfügbar ist, wird die Endpoint URL angezeigt.

API des Überwachungsprotokolldienstes

Als Alternative zum Anzeigen von Auditprotokollen auf der Seite Auditprotokollierung der Management Console können Sie Auditprotokolle mithilfe einer REST- API abrufen. Dazu müssen Sie entweder Befehlszeilenprogramme wie curl oder Anwendungen wie Postman verwenden.

Um die Audit Log Service API zu verwenden, müssen Sie die Audit-Protokollierung aktivieren für die Organisation (weiter oben auf dieser Seite beschrieben) gehen Sie folgendermaßen vor:

1. Rufen Sie mithilfe der User Service Controller API ein Authentifizierungstoken ab. Dieses Token ist erforderlich, um die Audit Log Service API verwenden zu können.

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

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

     1. TFA-Code abrufen

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

2. Protokolle abrufen mithilfe der Audit Log Service API.

Abrufen eines Authentifizierungstokens

Zum Abrufen eines Authentifizierungstokens ist die Verwendung der User Service Controller API erforderlich.

Eine Beispielanforderung, die die Anmeldung bei 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:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält neben dem Authentifizierungstoken (eine Liste der Organisationen, mit denen der Benutzer verbunden ist "authenticationToken"). Dieses Token wird für die nachfolgende Autorisierung mit der Audit Logging API benötigt. In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" Die Organisations-ID wird angezeigt als "123456" für die erste Organisation, 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 aktiviertem TFA

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

1. TFA-Code abrufen

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

Einen TFA-Code abrufen

Ein gültiger TFA-Code ist erforderlich, um ein Authentifizierungstoken abzurufen, wenn TFA aktiviert ist. Eine Beispielanforderung zeigt die Anmeldung bei der NA Region und die Anforderung eines TFA-Codes:

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:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält eine Fehlermeldung, die angibt, dass ein TFA-Code an die Email 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 des TFA-Codes zum Abrufen eines Authentifizierungstokens

Der an die Email-Adresse des Benutzers gesendete TFA-Code kann nun in der zweiten Anfrage verwendet werden, um das Authentifizierungstoken abzurufen. Eine Beispielanfrage, die die Anmeldung 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/code' \
--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:

Überschriften

Diese Header sind erforderlich:

Körperparameter

Die folgenden erforderlichen Parameter werden im Hauptteil der Anfrage übergeben:

Antworttext

Der zurückgegebene Antworttext enthält neben dem Authentifizierungstoken (eine Liste der Organisationen, mit denen der Benutzer verbunden ist "authenticationToken"). Dieses Token wird für die nachfolgende Autorisierung mit der Audit Logging API benötigt. In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" Die Organisations-ID wird angezeigt als "123456" für die erste Organisation, 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 Überwachungsprotokollen

Sobald Sie das Authentifizierungstoken, die Organisations-ID und einen Zeitraum haben, der Sie interessiert, können Sie Prüfprotokolle abrufen. Ein Beispiel, das das Abrufen aller Datensätze ab dem 1. Januar 2021 und einschließlich der detaillierten Version der Datensätze zeigt:

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:

Endpoints

Für den Audit Log Service sind die folgenden Endpoints (APIs) verfügbar:

URL Parameter

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

Überschriften

Diese Header können in der Anfrage verwendet werden:

Körperparameter

Die folgenden Parameter können im Textkörper der Anfrage übergeben werden:

Beispiel

Dieses Beispiel verwendet die auditlog/download Endpoint zum Abrufen aller Datensätze für Organisation 123456 mit der Aktion QUERY, beginnend ab dem 1. Januar 2023, einschließlich der detaillierten Version der Aufzeichnungen, und als CSV in einem komprimierten (ZIP-)Dateiformat in eine Ausgabedatei heruntergeladen:

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

Beispiel für eine Protokollausgabe

Dies ist ein Beispielfragment der JSON-Ausgabe, die von auditlog Endpoint:

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