Seite „App-Registrierungen“ in der Jitterbit-Management Console
Einführung
Auf der Seite App-Registrierungen können Harmony-Organisationsadministratoren 3-legged OAuth 2.0 (3LO)-Anwendungen von Drittpartei für die Verwendung mit bestimmten Integration Studio Konnektoren. Sobald die 3LO-Anwendung eines Drittpartei auf der Seite App-Registrierungen registriert ist, 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.
Notiz
Wenn Sie eine Cloud-Anwendung (von Jitterbit bereitgestellt) verwenden, ist zum Konfigurieren einer Verbindung keine App-Registrierung erforderlich.
Auf der Seite App-Registrierungen können Organisationsadministratoren private Anwendungen mit 3LO-fähigen Konnektoren registrieren, die Details des OAuth-Anbieters festlegen und das Verhalten der Aktualisierungstoken definieren. Um sie zu öffnen, wählen Sie Management Console > Anpassungen > App-Registrierungen aus dem Harmony Portalmenü:
Sie können anzeigen, erstellen, bearbeiten oder löschen Registrierungen sowie erweiterte Optionen anzeigen und bearbeiten für eine Registrierung. Ein Connector kann mehrfach registriert werden. Jeder wird als einzigartige Connector-App betrachtet.
Sicht
Wenn keine Registrierungen vorhanden sind, enthält der Hauptteil der Seite eine Symbolleiste und eine leere Tabelle:
Bei Registrierungen enthält der Hauptteil der Seite eine Symbolleiste und eine Tabelle mit verfügbaren Registrierungen:
-
Suchen: Geben Sie Text ein, um passende Einträge zu finden.
-
Neu erstellen: Neue Registrierung erstellen.
-
Aktionen: Bewegen Sie den Mauszeiger über eine Zeile, um die Aktionssymbole anzuzeigen:
-
Erweiterte Optionen: Erweiterte Optionen anzeigen für die Registrierung.
-
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 Connector-App-Registrierung zu erstellen, führen Sie die folgenden Schritte aus:
-
Klicken Sie auf Neu erstellen. Eine neue Zeile erscheint in der Tabelle:
-
Legen Sie Werte für die folgenden Felder fest:
Im Abschnitt Neue App-Registrierung erstellen:
-
Name: Ein für den Connector eindeutiger Name für die Registrierung.
-
Beschreibung: Eine Beschreibung für die Registrierung.
-
Connector: Klicken Sie, um das Menü zu öffnen, und wählen Sie dann einen der unterstützten Connectors aus. Derzeit unterstützen diese Connectors 3LO:
-
Client-ID: Die vom OAuth-Anbieter zugewiesene Client-ID.
-
Client-Geheimnis: Das vom OAuth-Anbieter zugewiesene Client-Geheimnis.
-
Geltungsbereich: Ein oder mehrere durch Leerzeichen getrennte OAuth 2.0 scopes.
Im Abschnitt Konfiguration:
-
Authentifizierungs-URL: Die URL, an die eine Autorisierungsanfrage gesendet werden soll.
-
URL des Zugriffstokens: Die URL, an die eine Zugriffstokenanforderung gesendet werden soll.
-
URL des Aktualisierungstokens: Die URL zum Anfordern eines neuen Zugriffstokens.
-
-
Klicken Sie auf Speichern um die Werte zu speichern, oder Abbrechen zum Abbrechen:
-
Nach erfolgreichem Speichern erscheint die Registrierung als neuer Eintrag in der Tabelle:
Bearbeiten
Um eine Registrierung zu bearbeiten, gehen Sie folgendermaßen vor:
-
Bewegen Sie den Mauszeiger ü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 im Bereich App-Registrierung bearbeiten die Felder und klicken Sie dann auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um den Vorgang abzubrechen.
Hinweis
Der Connector einer Registrierung kann von seinem Anfangswert nicht geändert werden.
-
Lesen Sie die Benachrichtigung, die oben rechts im Fenster angezeigt wird. Um die Benachrichtigung zu schließen, klicken Sie auf das Schließen-Symbol.
Löschen
So löschen Sie eine Registrierung:
-
Bewegen Sie den Mauszeiger über eine Registrierung in der Tabelle, um die Aktionssymbole anzuzeigen, und klicken Sie dann auf Löschen.
-
Ein Dialog App-Registrierung löschen wird geöffnet:
-
Geben Sie den Text LÖSCHEN 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-Anbieter bereitgestellten Standardeinstellungen für das Token jeder Registrierung sowie für die Authentifizierungs-, Token- und Aktualisierungsanforderungen.
Um sie zu öffnen, bewegen Sie den Mauszeiger über eine Registrierung in der Tabelle und klicken Sie dann auf Erweiterte Optionen. Die Schublade erscheint unten auf der Seite:
Die Schublade enthält diese Registerkarten:
Tipp
Wenn eine Tab ungültige Einstellungen hat, wird die Schaltfläche Speichern inaktiv und ein Fehlersymbol erscheint neben der Beschriftung der Registerkarte.
Token-Richtlinie
Die Tab Token-Richtlinie enthält Einstellungen für das Token:
Wichtig
Aktivieren Sie die Einstellungen der Tab Token-Richtlinie nur, wenn sie auch im OAuth-Anbieter aktiviert sind.
Die folgenden Einstellungen sind verfügbar:
-
Ablauf des Aktualisierungstokens aktivieren: Klicken Sie hier, um den Ablauf des auf dieser Seite generierten Aktualisierungstokens zu aktivieren. In Kombination mit der Einstellung Ablaufbenachrichtigung erhalten einer Verbindung wird der im entsprechenden Feld Tage für Ablaufbenachrichtigung der Verbindung konfigurierte Wert verwendet, um Sie die konfigurierte Anzahl von Tagen vor dem hier konfigurierten Ablauf des Aktualisierungstokens zu benachrichtigen. Wenn diese Option aktiviert ist, werden Sie mit einem Anwendungsbanner und einer Email benachrichtigt, wenn Token ablaufen oder bereits abgelaufen sind. Beide Benachrichtigungsformen sagen Ihnen, was in jedem Fall zu tun ist.
Wenn diese Einstellung aktiviert ist, wird die Email Benachrichtigung an die Administratoren der Harmony-Organisation (Mitglieder einer Rolle) gesendet mit der Berechtigung Admin und dem Benutzer, der das Projekt zuletzt bereitgestellt hat.
Um den Ablaufzeitraum festzulegen, geben Sie eine ganze Zahl größer als Null ein, klicken Sie dann auf das Menü und wählen Sie eine der Optionen Sekunden, Stunden oder Tage aus:
Tipp
Die empfohlene Einstellung für diesen Wert sollte mit der im OAuth-Anbieter selbst verwendeten übereinstimmen. Wenn beispielsweise das Ablaufdatum des Aktualisierungstokens eines OAuth-Anbieters 1 Jahr beträgt, legen Sie den Wert Ablauf nach auf 1 Jahr fest.
-
Ablauf des Aktualisierungstokens bei Inaktivität aktivieren: Klicken Sie hier, um den Ablauf des Tokens bei Inaktivität zu aktivieren. Um den Ablaufzeitraum festzulegen, geben Sie eine ganze Zahl größer als Null ein, klicken Sie dann auf das Menü und wählen Sie eine der Optionen Sekunden, Stunden oder Tage aus:
Tipp
Die empfohlene Einstellung für diesen Wert sollte mit der im OAuth-Anbieter selbst verwendeten übereinstimmen. Wenn beispielsweise die Inaktivitätsdauer des Aktualisierungstokens eines OAuth-Anbieters 90 Tage beträgt, legen Sie den Wert Ablauf nach auf 90 Tage fest.
-
Rotierendes Aktualisierungstoken aktivieren: Klicken Sie, um die Tokenrotation zu aktivieren:
Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.
Authentifizierungsanfrage
Die Tab Authentifizierungsanforderung enthält Einstellungen für die Token-Authentifizierungsanforderung:
-
Authentifizierungs-URL: Die URL, an die eine Autorisierungsanfrage gesendet werden soll.
-
Parameter: Um Parameter für die Anfrage hinzuzufügen, folgen Sie diesen Schritten:
-
Geben Sie Werte für Schlüssel und Wert ein.
-
Um die Methode zum Senden der Parameter auszuwählen, klicken Sie auf das Menü Senden in und wählen Sie dann eine der Optionen Anforderungs URL oder Anforderungsheader aus.
-
Klicken Sie auf Hinzufügen. Der Parameter erscheint als neue Zeile in der Tabelle.
-
Wiederholen Sie die drei vorherigen Schritte für alle Parameter.
-
Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.
Token-Anforderung
Die Tab Token-Anforderung enthält Einstellungen für die Token-Anforderung:
-
URL des Zugriffstokens: Die URL, an die eine Zugriffstokenanforderung gesendet werden soll.
-
Parameter: Um Parameter für die Anfrage hinzuzufügen, folgen Sie diesen Schritten:
-
Geben Sie Werte für Schlüssel und Wert ein.
-
Um die Methode zum Senden der Parameter auszuwählen, klicken Sie auf das Menü Senden in und wählen Sie dann eine der Optionen Anforderungs URL, Anforderungsheader oder Anforderungstext aus.
-
Klicken Sie auf Hinzufügen. Der Parameter erscheint als neue Zeile in der Tabelle.
-
Wiederholen Sie die drei vorherigen Schritte für alle Parameter.
-
Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.
Aktualisierungsanforderung
Die Tab Aktualisierungsanforderung enthält Einstellungen für die Token-Aktualisierungsanforderung:
-
URL des Aktualisierungstokens: Die URL zum Anfordern eines neuen Zugriffstokens.
-
Parameter: Um Parameter für die Anfrage hinzuzufügen, folgen Sie diesen Schritten:
-
Geben Sie Werte für Schlüssel und Wert ein.
-
Um die Methode zum Senden der Parameter auszuwählen, klicken Sie auf das Menü Senden in und wählen Sie dann eine der Optionen Anforderungs URL, Anforderungsheader oder Anforderungstext aus.
-
Klicken Sie auf Hinzufügen. Der Parameter erscheint als neue Zeile in der Tabelle.
-
Wiederholen Sie die drei vorherigen Schritte für alle Parameter.
-
Klicken Sie auf Speichern, um die Änderungen zu speichern, oder auf Abbrechen, um sie zu verwerfen.