Seite „App-Registrierungen" in der Jitterbit Management Console

Übersicht

Einführung

Auf dieser Seite können Sie Anwendungen mit 3-legged OAuth 2.0 (3LO) von Drittanbietern registrieren, um sie mit bestimmten Studio-Konnektoren zu verwenden. Nach der Registrierung der 3LO-Anwendung eines Drittanbieters können Sie eine Verbindung mit 3-legged OAuth 2.0 authentifizieren.

Weitere Informationen zur Authentifizierung einer Verbindung mit 3LO finden Sie unter 3LO-Authentifizierung.

Sie können Registrierungen anzeigen, erstellen, bearbeiten oder löschen sowie erweiterte Optionen anzeigen und bearbeiten oder die Endpoint-Nutzung für eine Registrierung anzeigen. Ein Konnektor kann mehrmals registriert werden. Jede wird als eindeutige Konnektor-App betrachtet.

Anzeigen

Der Seitenkörper enthält eine Symbolleiste und eine Tabelle mit verfügbaren Registrierungen:

• Suche: Text eingeben, um passende Einträge zu finden.

• Neu erstellen: Neue Registrierung erstellen.

• Nutzung: Ob die Registrierung von Endpoints referenziert wird:

  • In Verwendung: Ein oder mehrere Endpoints referenzieren die Registrierung.

  • Nicht verwendet: Kein Endpoint referenziert die Registrierung.

• Endpoints: Die Anzahl der Endpoints, die die Registrierung referenzieren, basierend auf den Projekten und Umgebungen, auf die Sie Zugriff haben. Weitere Informationen finden Sie unter Endpoint-Nutzung.

• Aktionen: Zeigen Sie auf eine Zeile, um die Aktionssymbole anzuzeigen:

  • Details anzeigen: Erweiterte Optionen und Endpoint-Nutzung für die Registrierung anzeigen.

  • Bearbeiten: Registrierung bearbeiten.

  • Löschen: Registrierung löschen.

Klicken Sie auf eine beliebige Spaltenüberschrift (außer Aktionen), um die Tabelle in aufsteigender Reihenfolge nach dieser Spalte zu sortieren. Klicken Sie erneut, um die Sortierreihenfolge umzukehren.

Erstellen

Um eine neue Konnektor-App-Registrierung zu erstellen, klicken Sie auf Neu erstellen. Eine neue Zeile wird in der Tabelle angezeigt.

Legen Sie im Abschnitt Neue App-Registrierung erstellen Werte für die folgenden Felder fest:

• Name: Ein Name für die Registrierung, der für den Konnektor eindeutig ist.

• Beschreibung: Eine Beschreibung für die Registrierung.

• Konnektor: Klicken Sie, um das Menü zu öffnen, und wählen Sie dann einen der unterstützten Konnektoren aus. Derzeit unterstützen diese Konnektoren 3LO:

  • BMC Helix ITSM
  • Gmail
  • Google Docs
  • Google Drive
  • Google Sheets
  • HTTP v2
  • Jira
  • MCP Client
  • Shopify
  • Slack
  • Snowflake
  • ZoomInfo

• Client-ID: Der von dem OAuth-Provider zugewiesene Client-Identifier.

• Client Secret: Das vom OAuth-Provider zugewiesene Client Secret.

• Scope: Ein oder mehrere durch Leerzeichen getrennte OAuth 2.0 Scopes.

Legen Sie im Bereich Konfiguration Werte für die folgenden Felder fest:

• Authentication URL: Die URL, an die eine Autorisierungsanfrage gesendet wird.

• Access token URL: Die URL, an die eine Access-Token-Anfrage gesendet wird.

• Refresh token URL: Die URL zum Anfordern eines neuen Access Tokens.

Klicken Sie auf , um die Werte zu speichern, oder auf , um abzubrechen:

Nach erfolgreichem Speichern wird die Registrierung als neuer Eintrag in der Tabelle angezeigt:

Bearbeiten

Fahren Sie mit der Maus über eine Registrierung in der Tabelle, um die Aktionssymbole anzuzeigen, und klicken Sie dann auf Bearbeiten. Der Bereich App-Registrierung bearbeiten wird angezeigt:

Bearbeiten Sie die Felder, und klicken Sie dann auf , um die Änderungen zu speichern, oder auf , um abzubrechen.

Lesen Sie die Benachrichtigungsmeldung, die oben rechts im Fenster angezeigt wird. Um die Benachrichtigung zu schließen, klicken Sie auf das Symbol Schließen.

Löschen

Fahren Sie mit der Maus über eine Registrierung in der Tabelle, um die Aktionssymbole anzuzeigen, und klicken Sie dann auf Löschen. Das Dialogfeld App-Registrierung löschen wird geöffnet:

Geben Sie den Text DELETE ein, und klicken Sie dann auf Löschen, oder klicken Sie auf Abbrechen, um die Aktion abzubrechen.

Erweiterte Optionen

Die Schublade Erweiterte Optionen enthält die vom OAuth-Provider bereitgestellten Standardeinstellungen für das Token jeder Registrierung sowie für die Authentifizierungs-, Token- und Aktualisierungsanfragen und die Endpoint-Nutzung der Registrierung.

Um sie zu öffnen, fahren Sie mit der Maus über eine Registrierung in der Tabelle, und klicken Sie dann auf Details anzeigen. Die Schublade wird unten auf der Seite angezeigt und enthält diese Registerkarten:

• Token-Richtlinie

• Authentifizierungsanfrage

• Token-Anfrage

• Aktualisierungsanfrage

• Endpoint-Nutzung

Token-Richtlinie

Die Registerkarte Token-Richtlinie enthält Einstellungen für das Token:

Die folgenden Einstellungen sind verfügbar:

• Token-Ablauf aktivieren: Wenn diese Option aktiviert ist und in Kombination mit den Einstellungen Ablaufbenachrichtigung empfangen und Tage für Ablaufbenachrichtigung einer Verbindung verwendet wird, erhalten Sie E-Mail-Benachrichtigungen und ein Benachrichtigungsbanner im gesamten Harmony-Portal, das Sie daran erinnert, ein neues Refresh Token zu erhalten, wenn das aktuelle abgelaufen ist oder kurz vor dem Ablauf steht. Wenn ein Refresh Token abläuft, schlagen alle abhängigen Operationen zur Laufzeit fehl.

  Wenn diese Einstellung aktiviert ist, wird die E-Mail-Benachrichtigung an die Harmony-Organisationsadministratoren gesendet (Mitglieder einer Rolle mit der Berechtigung Admin und der Benutzer, der das Projekt zuletzt bereitgestellt hat).

  Um den Ablaufzeitraum festzulegen, geben Sie eine ganze Zahl größer als Null ein, klicken Sie auf das Menü, und wählen Sie eine der Optionen Sekunden, Stunden oder Tage.

  Tipp

  Die empfohlene Einstellung für diesen Wert sollte mit der im OAuth-Provider selbst verwendeten Einstellung übereinstimmen. Wenn beispielsweise die Ablaufzeit des Refresh Tokens eines OAuth-Providers 1 Jahr beträgt, stellen Sie den Wert Ablauf nach auf 1 Jahr ein.

• Aktualisierungstoken-Inaktivitätsablauf aktivieren: Wenn diese Option aktiviert ist, werden Aktualisierungstoken, die für den angegebenen Zeitraum inaktiv waren, in der Harmony-Plattform als abgelaufen markiert. Verwenden Sie das Feld Ablauf nach, um das Intervall anzugeben, nach dem ein inaktives Aktualisierungstoken als abgelaufen markiert wird.

  Wichtig

  Verwenden Sie diese Einstellung in Abstimmung mit der Inaktivitätseinstellung des OAuth-Anbieters. Wenn diese Einstellung aktiviert wird, während der OAuth-Anbieter keine Inaktivitätseinstellung definiert hat, werden gültige Aktualisierungstoken in der Harmony-Plattform fälschlicherweise als abgelaufen betrachtet. Umgekehrt: Falls der OAuth-Anbieter diese Einstellung definiert hat, sie aber nicht aktiviert und hier im Harmony-Portal angegeben ist, könnte der Endpunkt ein veraltetes Aktualisierungstoken verwenden, was möglicherweise zu Problemen basierend auf den Aktualisierungstoken-Regeln des OAuth-Anbieters führt.

  • Ablauf nach: Um den Ablaufzeitraum festzulegen, geben Sie eine ganze Zahl größer als null ein, klicken Sie auf das Menü und wählen Sie eine der Optionen Sekunden, Stunden oder Tage.

    Tipp

    Die empfohlene Einstellung für diesen Wert sollte der im OAuth-Anbieter selbst verwendeten Einstellung entsprechen. Wenn beispielsweise der Aktualisierungstoken-Inaktivitätsablauf eines OAuth-Anbieters 90 Tage beträgt, stellen Sie den Wert Ablauf nach auf 90 Tage ein.

• Rotierendes Aktualisierungstoken aktivieren: Klicken Sie, um die Token-Rotation zu aktivieren.

Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.

Authentifizierungsanfrage

Die Registerkarte Authentifizierungsanfrage enthält Einstellungen für die Token-Authentifizierungsanfrage:

• Authentifizierungs-URL: Die URL, an die eine Autorisierungsanfrage gesendet wird.

• Parameter: Um einen Parameter hinzuzufügen, geben Sie Werte für Schlüssel und Wert ein, klicken Sie auf das Menü Senden in und wählen Sie Anfrage-URL oder Anfrage-Header, klicken Sie dann auf Hinzufügen. Der Parameter wird als neue Zeile in der Tabelle angezeigt. Wiederholen Sie diesen Vorgang für jeden Parameter, den Sie hinzufügen möchten.

Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.

Token-Anfrage

Die Registerkarte Token-Anfrage enthält Einstellungen für die Token-Anfrage:

• Zugriffstokens-URL: Die URL, an die eine Zugriffstokenanfrage gesendet wird.

• Parameter: Um einen Parameter hinzuzufügen, geben Sie Werte für Schlüssel und Wert ein, klicken Sie auf das Menü Senden in und wählen Sie Anfrage-URL, Anfrage-Header oder Anfrage-Text, klicken Sie dann auf Hinzufügen. Der Parameter wird als neue Zeile in der Tabelle angezeigt. Wiederholen Sie diesen Vorgang für jeden Parameter, den Sie hinzufügen möchten.

Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.

Aktualisierungsanfrage

Die Registerkarte Aktualisierungsanfrage enthält Einstellungen für die Token-Aktualisierungsanfrage:

• Aktualisierungstoken-URL: Die URL zum Anfordern eines neuen Zugriffstokens.

• Parameter: Um einen Parameter hinzuzufügen, geben Sie Werte für Schlüssel und Wert ein, klicken Sie auf das Menü Senden in und wählen Sie Anfrage-URL, Anfrage-Header oder Anfrage-Text, klicken Sie dann auf Hinzufügen. Der Parameter wird als neue Zeile in der Tabelle angezeigt. Wiederholen Sie diesen Vorgang für jeden Parameter, den Sie hinzufügen möchten.

Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.

Endpunkte-Nutzung

Die Registerkarte Endpunkte-Nutzung listet die Endpunkte auf, die auf die Registrierung verweisen:

Diese Registerkarte zeigt Konfigurationsverweise an, nicht die Laufzeitaktivität. Informationen zur Endpunktaktivität basierend auf Operationsausführungen finden Sie auf der Seite Endpunkte-Nutzung.

Die Tabelle enthält die folgenden Spalten:

• Endpunktname: Der Name des Endpunkts, der auf die Registrierung verweist.

• Projektname: Der Name des Projekts, das den Endpunkt enthält.

• Projekt-ID: Der eindeutige Bezeichner des Projekts.

• Umgebung: Die Umgebung, in der der Endpoint verwendet wird.

• Verbindungstyp: Der vom Endpoint verwendete Connector.

• Läuft ab: Der Ablaufstatus des Tokens, falls verfügbar.

• Autorisierungsstatus: Der aktuelle Autorisierungsstatus des Endpoints, falls verfügbar.

• Zuletzt bereitgestellt: Datum und Uhrzeit der letzten Bereitstellung des Endpoints.

• Aktionen: Fahren Sie mit der Maus über einen Endpoint, um diese Aktion anzuzeigen:

  • Zum Endpoint wechseln: Öffnet die Konfiguration des Endpoints in Studio.

Wenn die Registrierung von keinen Endpoints referenziert wird, zeigt die Registerkarte Folgendes an:

Fehlerbehebung

Weitere Informationen zur Fehlerbehebung finden Sie in den folgenden Abschnitten im Harmony-Fehlerbehebungsleitfaden:

• OAuth-Aktualisierungstoken-Ablauf führt zu Fehlern bei verbundenen Operationen