Google OAuth-Konfigurationshandbuch für Jitterbit App Builder
Zweck des Dokuments
Beschreiben Sie die erforderlichen Konfigurationsschritte, um App Builder so zu konfigurieren, dass Google als externer OIDC/OAuth 2.0-Sicherheitsanbieter für die Benutzerauthentifizierung verwendet wird.
Einführung
Die Konfiguration der externen Authentifizierung erfordert die Einrichtung sowohl beim Identitätsanbieter als auch in der App Builder Instanz. In beiden Fällen sind Administratorrechte erforderlich.
Wichtig
Die in diesem Handbuch angegebenen Beispielwerte sind repräsentativ, aber fiktiv und sollten nicht in der realen Konfiguration verwendet werden. Wir verwenden https://example.zudy.com/App Builder
als Instanzstamm in dieser Dokumentation.
Schritte im App Builder
Erstellen eines Sicherheitsanbieters
- Melden Sie sich als Administrator beim App Builder an
- Navigieren Sie zu IDE > Sicherheitsanbieter
- Klicken Sie im Abschnitt Benutzerauthentifizierung auf + Benutzerauthentifizierung, um einen neuen Sicherheitsanbieter hinzuzufügen
-
Geben Sie die folgenden Werte ein:
- Name: Kurzer, beschreibender Name für den Sicherheitsanbieter. Vermeiden Sie Leerzeichen. Dieser wird Teil des Authentifizierungspfads des App Builder.
- Typ: Externe Authentifizierung > OAuth
- Priorität: Standardvorschlag akzeptieren oder nach Ihren Wünschen aktualisieren
-
Aktiviert: Aktivieren
- Authentifizierungstyp: OAuth
- OAuth Grant: Autorisierungscode
-
OAuth-Client-Authentifizierung: Einfach
- OAuth-Ressourcenauthentifizierung: Träger
- Token-Besitzer: Benutzer
- Weiterleitung bei Herausforderung: Prüfen
- Im Anmeldeformular anzeigen: Aktivieren
- Benutzerbereitstellung: Prüfen
- Store-Ansprüche: Aktivieren. Dies ist bei der Ersteinrichtung und Fehlerbehebung wichtig, kann aber später bei Bedarf entfernt werden.
-
Klicken Sie auf Speichern
Schritte in Google Workspace/Google Cloud Platform
Hinweis
Beachten Sie, dass Sie Administratorzugriff auf das Google Workspace-Konto Ihrer Organisation benötigen, um ein neues Projekt zu erstellen, oder über die Berechtigung zum Erstellen und Konfigurieren von OAuth 2.0-Anmeldeinformationen für ein bestehendes Projekt verfügen.
Erstellen eines neuen Projekts
- Gehen Sie zur Seite Ressourcen verwalten in der Google Cloud Console
- Melden Sie sich als Administrator an, wenn Sie dazu aufgefordert werden.
- Wählen Sie in der Dropdown-Liste Organisation auswählen oben auf der Seite die Organisation aus, in der Sie ein Projekt erstellen möchten. Wenn Sie die kostenlose Testversion nutzen, überspringen Sie diesen Schritt, da er nicht zutrifft.
- Klicken Sie auf Projekt erstellen.
- Geben Sie im angezeigten Fenster Neues Projekt einen Projektnamen ein. Ein Projektname darf nur Buchstaben, Zahlen, einfache Anführungszeichen, Bindestriche, Leerzeichen oder Ausrufezeichen enthalten und muss zwischen 4 und 30 Zeichen lang sein. Es sollte ein beschreibender und eindeutiger Name sein, der das Projekt identifiziert. Beispiel: vinyl-authentication
- Wählen Sie die übergeordnete Organisation im Feld Organisation aus.
- Wählen Sie optional einen Ordner im Feld Speicherort aus. Diese Ressource wird die hierarchische übergeordnete Ressource des neuen Projekts sein.
- Klicken Sie auf Erstellen.
Weitere Informationen zum Erstellen von Projekten finden Sie in der Google-Dokumentation unter: https://cloud.google.com/resource-manager/docs/creating-managing-projects
Konfigurieren Sie den OAuth-Zustimmungsbildschirm und erstellen Sie API Anmeldeinformationen
- Nachdem Sie das Projekt erstellt haben, öffnen Sie die Seite Anmeldeinformationen in der Google API Konsole. Startseite > APIs und Dienste > Anmeldeinformationen
- Überprüfen Sie den Projektnamen oben links neben dem Logo, um sicherzustellen, dass Sie das richtige Projekt verwenden. Klicken Sie bei Bedarf auf den Dropdown-Pfeil, um das Projekt zu wechseln.
- Klicken Sie auf Anmeldeinformationen erstellen → OAuth-Client-ID
-
Sofern Sie nicht bereits einen Zustimmungsbildschirm eingerichtet haben, werden Sie zunächst aufgefordert, Ihren Zustimmungsbildschirm zu konfigurieren. Der Zustimmungsbildschirm wird den Endnutzern beim ersten Zugriff auf die Anwendung (App Builder) mit ihren Google-Anmeldeinformationen angezeigt und fordert sie auf, den Zugriff auf ihr Google-Konto zu akzeptieren. Wenn Sie bereits einen Zustimmungsbildschirm und entsprechende Bereiche konfiguriert haben, fahren Sie mit Schritt 29 fort.
Beispiel für die Konfiguration des Zustimmungsbildschirms
-
Klicken Sie auf Zustimmungsbildschirm konfigurieren
- Wählen Sie Intern für Benutzertyp und klicken Sie auf Erstellen
- Füllen Sie den Abschnitt „App-Informationen“ wie folgt aus:
- App-Name: Geben Sie den Namen der benutzerdefinierten App ein. Beispiel: App Builder-Instanz. Normalerweise geben Sie „Entwicklung“, „Qualitätssicherung“ oder „Produktion“ bzw. den Zweck der Instanz an, falls dieser abweicht.
- Email des Benutzersupports: Geben Sie die Email - Adresse eines Administrators oder einer Gruppe ein.
- App-Logo: Laden Sie optional eine Datei hoch, die als Logo verwendet werden soll
- Füllen Sie den Abschnitt App-Domäne mit der URL der Anwendungshomepage und einem Link zur Datenschutzrichtlinie und/oder den Nutzungsbedingungen Ihres Unternehmens aus
- Fügen Sie unter Autorisierte Domänen den Domänennamen hinzu, zu dem die App Builder Instanz gehört. Dies kann Ihre eigene Domäne oder Host sein. Fügen Sie gegebenenfalls mehrere Domänen hinzu.
- Geben Sie eine Support-Email-Adresse für Kontaktinformationen des Entwicklers ein
- Klicken Sie auf Speichern und Weiter
-
Identifizieren Sie auf dem Bildschirm Bereiche die Informationen, die vom App Builder über den Benutzer angefordert werden. Klicken Sie auf Bereiche hinzufügen und wählen Sie die drei im folgenden Screenshot gezeigten Bereiche aus.
Beispiel für die Konfiguration von Bereichen
-
Klicken Sie auf Aktualisieren
Notiz
Beachten Sie, dass diese als „nicht sensible Bereiche“ gelten. App Builder benötigt keine anderen Bereiche.
-
Klicken Sie auf Speichern und Weiter
- Überprüfen Sie die Übersichtsseite und klicken Sie auf Zurück zum Dashboard
- Klicken Sie auf Anmeldeinformationen erstellen → OAuth-Client-ID
- Wählen Sie unter Anwendungstyp Webanwendung
- Geben Sie unter Name eine beschreibende Bezeichnung für die Anwendung ein. Dieser Wert wird nicht anderweitig verwendet. Beispiel: App Builder-Instanz. Normalerweise geben Sie „Entwicklung“, „Qualitätssicherung“ oder „Produktion“ bzw. den Zweck der Instanz an, falls dieser abweicht.
-
Geben Sie unter Autorisierte JavaScript-Ursprünge die URI an, die den FQDN (Fully Qualified Domain Name) Ihrer App Builder Instanz darstellt. Beachten Sie, dass diese keine Pfadangaben enthalten darf. Beispiel:
https://example.zudy.com
23. Der fertige Bildschirm sollte in etwa wie folgt aussehen:Beispiel für die Konfiguration einer OAuth-Client-ID
-
Ein Popup-Fenster mit Ihren OAuth-Anmeldeinformationen sollte erscheinen. Diese Anmeldeinformationen sollten geheim gehalten werden und ähneln im Format den unten aufgeführten fiktiven Beispielen. Lassen Sie dieses Popup-Fenster für die nächsten Konfigurationsschritte geöffnet.
- Beispiele:
- Ihre Client-ID:
825669012735-hd1oct8l1yeysoslrvtmf6b4gqkl12om.apps.googleusercontent.com
- Ihr Client-Geheimnis:
CRZEXT-zd_Qa_MCZ3rArp5hkRD3B16PPDLN
-
Damit sind die Schritte in Google Workspace/Google Cloud Platform abgeschlossen.
Schritte im App Builder
Konfigurieren der Eigenschaften und Anspruchstypen des Sicherheitsanbieters
- Kehren Sie zur Konfigurationsseite für den in den Schritten 1 bis 5 erstellten Dienstanbieter zurück.
-
Klicken Sie im Abschnitt Endpoints auf + Endpoint und Speichern Sie die folgenden 3 Eigenschaften wie unten angegeben:
- AuthorizationEndpoint: Verwenden Sie den folgenden Wert:
https://accounts.google.com/o/oauth2/v2/auth
- Hinweis: Dies ist kein Beispiel, sondern gilt allgemein für die Google OAuth v2-Konfiguration.
- TokenEndpoint: Verwenden Sie den folgenden Wert:
https://www.googleapis.com/oauth2/v4/token
- UserInfoEndpoint: Verwenden Sie den folgenden Wert:
https://openidconnect.googleapis.com/v1/userinfo
- AuthorizationEndpoint: Verwenden Sie den folgenden Wert:
-
Klicken Sie im Abschnitt Anmeldeinformationen auf + Anmeldeinformationen und Speichern Sie die folgenden Eigenschaften wie unten angegeben:
- Typ: Client
- Benutzername: Verwenden Sie die Client-ID aus Schritt 32 des vorherigen Abschnitts.
- Passwort: Verwenden Sie das Client-Geheimnis aus Schritt 32 des vorherigen Abschnitts.
-
Klicken Sie im Abschnitt Eigenschaften auf + Eigenschaft und Speichern Sie die folgenden Eigenschaften:
- Bereiche: Verwenden Sie die drei unten angezeigten Bereichswerte. Trennen Sie die einzelnen Zeichenfolgen durch ein Leerzeichen:
- openid
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/userinfo.profile
- Bereiche: Verwenden Sie die drei unten angezeigten Bereichswerte. Trennen Sie die einzelnen Zeichenfolgen durch ein Leerzeichen:
-
Klicken Sie im Abschnitt Ansprüche auf + Anspruch und speichern Sie die folgenden Anspruchsarten:
- Kennung: Email (Kleinbuchstaben, keine Leerzeichen)
- Verwendung: Name
- Name: beschreibende Bezeichnung. Beispiel: Name
-
Klicken Sie auf Speichern
-
Klicken Sie auf Erstellen
- Kennung: Email
- Verwendung: E-Mail-Adresse
- Name: beschreibende Bezeichnung. Beispiel: Email-Adresse
-
Klicken Sie auf Speichern
Notiz
Der Anspruchstyp für die Verwendung der E-Mail-Adresse ist optional, stellt jedoch sicher, dass das Attribut „Email-Adresse“ des App Builder Benutzers ausgefüllt wird, wenn sich der Benutzer mithilfe des externen Authentifizierungsanbieters bei App Builder anmeldet.
-
Damit sind die Konfigurationsschritte im App Builder abgeschlossen
Testen
Die Konfiguration ist nun testbereit. Es wird empfohlen, alle Tests in einem neuen Inkognito- oder privaten Browserfenster oder in einem anderen Browser durchzuführen.
Testschritte
-
Navigieren Sie zur Anmeldeseite der App Builder-Instanz und:
- Bestätigen Sie, dass die neue Authentifizierungsmethode auf der Anmeldeseite entsprechend angezeigt wird.
- Versuchen Sie, sich mit der neuen Authentifizierungsmethode anzumelden und überprüfen Sie das Ergebnis. (Dies sollte mit einem anderen Login als dem für die Verwaltung des App Builder verwendeten erfolgen.)
-
Wenn Fehler gemeldet werden, überprüfen Sie die gesamte Konfiguration und bestätigen Sie, dass die Elemente, die übereinstimmen müssen, korrekt sind. Stellen Sie insbesondere sicher, dass das Client Secret und die Client ID korrekt von Google in den App Builder kopiert wurden.
- Wenn alle Einstellungen vorhanden sind und korrekt erscheinen, die externe Authentifizierung aber immer noch nicht funktioniert, wenden Sie sich bitte an den App Builder Support.