Google OAuth 3-legged 2.0 API Sicherheitsprofil im Jitterbit API-Manager

Einführung

In einem Sicherheitsprofil können Sie Google als OAuth 2.0-Identitätsanbieter konfigurieren, um API Verbrauchern mithilfe der Google-Authentifizierung Zugriff auf eine API zu gewähren.

Auf dieser Seite wird gezeigt, wie Sie die Google-Authentifizierung mit einer benutzerdefinierten Jitterbit-, OData oder Proxy-API konfigurieren und verwenden, indem Sie die folgenden Schritte ausführen:

1. Google als Identitätsanbieter konfigurieren
   Konfigurieren Sie ein Google-Projekt und erhalten Sie die Client-ID und das Client-Geheimnis, die Sie als Eingabe zum Konfigurieren eines Sicherheitsprofils im API-Manager benötigen.
2. Konfigurieren Sie ein Sicherheitsprofil im API-Manager
   Konfigurieren und testen Sie Google als Identitätsanbieter im API-Manager. Sie müssen die Client-ID und das Client-Geheimnis verwenden, die Sie im vorherigen Schritt erhalten haben.
3. Sicherheitsprofil im API-Manager zuweisen
   Weisen Sie das Sicherheitsprofil einer oder mehreren benutzerdefinierten Jitterbit-, OData oder Proxy-APIs zu.
4. Greifen Sie mit Google-Authentifizierung auf eine API zu
   API Verbraucher können die Google-Authentifizierung verwenden, um benutzerdefinierte Jitterbit-, OData oder Proxy APIs zu nutzen, denen das Sicherheitsprofil zugewiesen ist.

Weitere Informationen finden Sie im Hilfethema APIs verwalten der Google API Console.

1. Konfigurieren Sie Google als Identitätsanbieter

Befolgen Sie diese Schritte, um ein Google-Projekt zu erstellen und die Client-ID und das Client-Geheimnis abzurufen, die zum Konfigurieren von Google als Identitätsanbieter für ein Sicherheitsprofil erforderlich sind:

1. Melden Sie sich bei der Google API Console an.

2. Klicken Sie in der Google API Konsole im Dashboard auf Projekt erstellen. Je nach Anwendungsfall müssen Sie möglicherweise mehr als ein Projekt erstellen, um den Zugriff für verschiedene Sicherheitsprofile zu trennen.

3. Geben Sie auf dem Bildschirm Neues Projekt einen Projektnamen Ihrer Wahl ein. Sie können das Projekt beispielsweise Jitterbit API-Manager APIs nennen, wenn das Sicherheitsprofil allen APIs zugewiesen wird, für die Sie die Google-Authentifizierung verwenden möchten, oder Sie können das Projekt Jitterbit API-Manager Customer APIs nennen, wenn das Sicherheitsprofil einer bestimmten Gruppe von APIs zugewiesen werden soll.

   Wählen Sie bei Bedarf eine entsprechende Organisation und einen Standort aus. Klicken Sie dann auf Erstellen:

   

4. Gehen Sie zur Tab OAuth-Zustimmungsbildschirm des Projekts und wählen Sie Extern. Klicken Sie dann auf Erstellen:

   

5. Geben Sie im resultierenden Konfigurationsbereich des OAuth-Zustimmungsbildschirms einen App-Namen an (z. B. Jitterbit API-Manager APIs) und füllen Sie die erforderlichen Kontaktinformationsfelder aus. Jede weitere Konfiguration über die Standardeinstellungen hinaus ist optional. Klicken Sie auf Speichern und fortfahren.

6. Wechseln Sie zur Tab Anmeldeinformationen des Projekts, um die Anmeldeinformationen für das Sicherheitsprofil zu konfigurieren:

   

   1. Klicken Sie auf Anmeldeinformationen erstellen und wählen Sie aus der Dropdown-Liste die OAuth-Client-ID aus.
   2. Wählen Sie als Anwendungstyp eine Webanwendung aus.
   3. Geben Sie einen Namen an (z. B. Jitterbit API-Manager APIs).

   4. Klicken Sie unter Autorisierte Umleitungs-URIs auf URI hinzufügen und geben Sie die für Ihre Harmony-Organisation und Region passenden URIs ein:

      1. Geben Sie die beiden URI-Werte ein, die Sie aus dem Sicherheitsprofil-Konfigurationsbildschirm kopiert haben (das Bild unten ist zugeschnitten, um die relevanten Bereiche anzuzeigen):

         

      2. Geben Sie den für Ihre Region passenden URI-Wert ein (siehe Meine Region suchen):

         • NA: https://apps.na-east.jitterbit.com/api-manager/swagger-ui/oauthredirect
         • EMEA: https://apps.emea-west.jitterbit.com/api-manager/swagger-ui/oauthredirect
         • APAC: https://apps.apac-southeast.jitterbit.com/api-manager/swagger-ui/oauthredirect

7. Nachdem Sie auf Erstellen geklickt haben, werden die Client-ID und das Client-Geheimnis bereitgestellt. Bewahren Sie diese für die spätere Verwendung auf, da sie beim Konfigurieren des Sicherheitsprofils erforderlich sind.

2. Konfigurieren Sie ein Sicherheitsprofil im API-Manager

Folgen Sie den Anweisungen zum Konfigurieren eines Sicherheitsprofils in Sicherheitsprofilkonfiguration.

Wählen Sie während der Konfiguration OAuth 2.0 als Authentifizierungs-Typ und Google als OAuth-Anbieter:

Geben Sie die Werte OAuth-Client-ID und OAuth-Client-Geheimnis ein, die Sie im vorherigen Abschnitt erhalten haben, Google als Identitätsanbieter konfigurieren:

Klicken Sie auf Client-ID + Geheimnis testen, um die Konnektivität mit dem Identitätsanbieter anhand der Konfiguration zu überprüfen.

3. Zuweisen eines Sicherheitsprofils im API-Manager

Um das Sicherheitsprofil mit einer API zu verwenden, folgen Sie den Anweisungen zum Konfigurieren einer benutzerdefinierten API, OData Dienst oder Proxy-API und wählen Sie das mit der Google OAuth 2.0-Authentifizierung konfigurierte Sicherheitsprofil aus.

4. Zugriff auf eine API mit Google-Authentifizierung

Nachdem Sie eine Custom API gespeichert und veröffentlicht haben, OData Dienst oder Proxy-API, ist die API per URL in der Anwendung zugänglich, die die API unter Verwendung der konfigurierten Authentifizierungsmethode aufruft.

Um die API zu nutzen, verwenden Sie den Link zum Kopieren der URL und verwenden Sie ihn in der aufrufenden Anwendung:

Wenn die API GET unterstützt, können Sie die URL auch in einen Webbrowser einfügen, um die API manuell zu nutzen.

Der Browser leitet Sie zur nativen Anmeldeoberfläche für Google weiter. Geben Sie Ihre Anmeldeinformationen ein, um sich bei Google zu authentifizieren.

Wenn die Authentifizierung erfolgreich ist, wird die erwartete Payload im Webbrowser angezeigt.