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

Einführung

Innerhalb eines Sicherheitsprofils können Sie Salesforce als OAuth 2.0-Identitätsanbieter konfigurieren, um API Verbrauchern mithilfe der Salesforce Authentifizierung Zugriff auf eine API zu gewähren.

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

1. Salesforce als Identitätsanbieter aktivieren
   Konfigurieren Sie die Salesforce Instanz als Identitätsanbieter.
2. Erstellen einer verbundenen App in Salesforce
   Konfigurieren Sie eine verbundene App in Salesforce und erhalten Sie den Salesforce-Consumer Key (Client-ID) und das Salesforce-Consumer Secret (Client Secret), die Sie als Eingabe für die Konfiguration eines Sicherungsprofils im API-Manager benötigen.
3. Konfigurieren Sie ein Sicherheitsprofil im API-Manager
   Konfigurieren und testen Sie Salesforce als Identitätsanbieter im API-Manager. Sie müssen die Client-ID und das Client-Geheimnis verwenden, die Sie im vorherigen Schritt erhalten haben.
4. Sicherheitsprofil im API-Manager zuweisen
   Weisen Sie das Sicherheitsprofil einer oder mehreren benutzerdefinierten Jitterbit-, OData oder Proxy-APIs zu.
5. Greifen Sie mit Salesforce Authentifizierung auf eine API zu
   API Verbraucher können die Salesforce Authentifizierung verwenden, um benutzerdefinierte Jitterbit-, OData oder Proxy APIs zu nutzen, denen das Sicherheitsprofil zugewiesen ist.

Weitere Informationen finden Sie in der Salesforce-Dokumentation Salesforce als Identitätsanbieter aktivieren und Apps mit OAuth autorisieren.

1. Salesforce als Identitätsanbieter aktivieren

Führen Sie die folgenden Schritte aus, um Salesforce als Identitätsanbieter in der Salesforce Classic-Benutzeroberfläche zu aktivieren:

1. Melden Sie sich als Salesforce Administrator bei der Salesforce-Instanz an.

2. Navigieren Sie in der Salesforce Classic-Benutzeroberfläche zu Setup > Verwalten > Sicherheitskontrollen > Identitätsanbieter.

3. Überprüfen Sie im Abschnitt Einrichtung des Identitätsanbieters, ob Sie einen Domänennamen konfiguriert haben und Salesforce als Identitätsanbieter aktiviert ist:

   • Wenn Sie keine Domäne konfiguriert haben, klicken Sie auf den Link zum Konfigurieren eines Domänennamens und befolgen Sie die Schritte zum Einrichten einer Domäne und deren einsetzen für Benutzer. Dadurch wird Salesforce automatisch als Identitätsanbieter aktiviert.

   • Wenn Sie eine Domäne konfiguriert, aber als Identitätsanbieter deaktiviert haben, klicken Sie auf die Schaltfläche Identitätsanbieter aktivieren.

   

   Tipp

   Nachdem Sie Änderungen im Identity Provider Setup vorgenommen haben, müssen Sie die Seite möglicherweise aktualisieren.

2. Erstellen Sie eine verbundene App in Salesforce

Befolgen Sie diese Schritte, um eine verbundene App in Salesforce zu konfigurieren und den Salesforce Consumer Key (Client-ID) und das Salesforce Consumer Secret (Client Secret) abzurufen:

1. Wenn Sie mit Salesforce als Identitätsanbieter aktivieren fortfahren, klicken Sie auf demselben Bildschirm im Abschnitt Dienstanbieter auf den Link zum Erstellen über Verbundene Apps. Navigieren Sie andernfalls zu Setup > Erstellen > Erstellen > Apps und klicken Sie im Abschnitt Verbundene Apps auf Neu.

2. Geben Sie unter Grundlegende Informationen einen Namen der verbundenen App an (z. B. Jitterbit API-Manager APIs) und füllen Sie andere erforderliche Felder aus.

3. Wählen Sie unter API (OAuth-Einstellungen aktivieren) die Option OAuth-Einstellungen aktivieren aus. Dadurch werden die zusätzlichen Felder Rückruf-URL und Ausgewählte OAuth-Bereiche aktiviert:

   

   • Rückruf URL: Geben Sie die für Ihre Harmony-Organisation und Region passenden URLs ein:

     1. Geben Sie die beiden URL 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 URL 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
        • Ausgewählte OAuth-Bereiche: Wählen Sie diese OAuth-Bereiche aus, indem Sie sie in Ausgewählte OAuth-Bereiche verschieben:
     3. Vollzugriff (voll)
        
     4. Führen Sie in Ihrem Namen jederzeit Anfragen aus (Refresh-Token, Offline-Zugriff)
        

4. Wenn Sie auf Speichern klicken, werden der Consumer Key (entspricht der Client-ID im API-Manager) und der Consumer Secret (entspricht dem Client Secret im API-Manager) unter API (OAuth-Einstellungen aktivieren) angezeigt. Bewahren Sie diese für die spätere Verwendung auf, da sie beim Konfigurieren des Sicherheitsprofils erforderlich sind.

3. 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 Salesforce als OAuth-Anbieter:

Geben Sie die Werte für OAuth-Client-ID (Salesforce Consumer Key) und OAuth-Client-Secret (Salesforce Consumer Secret) ein, die Sie im vorherigen Abschnitt Eine verbundene App in Salesforce erstellen erhalten haben:

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

4. 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 Salesforce OAuth 2.0-Authentifizierung konfigurierte Sicherheitsprofil aus.

5. Zugriff auf eine API mit Salesforce 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 Salesforce weiter. Geben Sie Ihre Anmeldeinformationen ein, um sich bei Salesforce zu authentifizieren.

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