Okta 3-legged OAuth 2.0 API Sicherheitsprofil im Jitterbit API-Manager
Einführung
Innerhalb eines Sicherheitsprofils können Sie Okta als OAuth 2.0-Identitätsanbieter konfigurieren, um API Verbrauchern mithilfe der Okta Authentifizierung Zugriff auf eine API zu gewähren.
Auf dieser Seite wird gezeigt, wie Sie die Okta-Authentifizierung mit einer benutzerdefinierten Jitterbit-, OData oder Proxy API konfigurieren und verwenden, indem Sie die folgenden Schritte ausführen:
- Okta als Identitätsanbieter konfigurieren
Konfigurieren Sie die Okta Instanz als Identitätsanbieter und erhalten Sie die Okta Client-ID und das Client-Geheimnis, die Sie als Eingabe zum Konfigurieren eines Sicherheitsprofils im API-Manager benötigen. - Konfigurieren Sie ein Sicherheitsprofil im API-Manager
Konfigurieren und testen Sie Okta als Identitätsanbieter im API-Manager. Sie müssen die Client-ID und das Client-Geheimnis verwenden, die Sie im vorherigen Schritt erhalten haben. - Sicherheitsprofil im API-Manager zuweisen
Weisen Sie das Sicherheitsprofil einer oder mehreren benutzerdefinierten Jitterbit-, OData oder Proxy-APIs zu. - Greifen Sie mit Okta Authentifizierung auf eine API zu
API Verbraucher können dann die Okta Authentifizierung verwenden, um benutzerdefinierte Jitterbit-, OData oder Proxy-APIs zu nutzen, denen das Sicherheitsprofil zugewiesen ist.
Weitere Informationen finden Sie in der Okta-Dokumentation Übersicht über OAuth 2.0 und OpenID Connect.
Informationen zur Konfiguration des Okta 2-legged OAuth-Sicherheitsprofils finden Sie unter Okta 2-legged OAuth 2.0 API Sicherheitsprofil.
1. Konfigurieren Sie Okta als Identitätsanbieter
-
Melden Sie sich bei der Okta Developer Console an als Benutzer mit Administratorrechten.
-
Navigieren Sie in der Entwicklerkonsole von Okta zu Anwendungen > Anwendungen und klicken Sie dann auf die Schaltfläche App-Integration erstellen.
-
Wählen Sie im Schritt Anmeldemethode der Seite Neue App-Integration erstellen OIDC - OpenID Connect aus. Wählen Sie für den Anwendungstyp Webanwendung aus und klicken Sie dann auf Weiter.
-
Konfigurieren Sie im Schritt Allgemeine Einstellungen der Seite Neue Web-App-Integration die Anmeldeinformationen für das Sicherheitsprofil:
-
Geben Sie einen App-Integrationsnamen ein (z. B. Jitterbit API-Manager APIs).
-
Unter Zuschussart:
- Wenn Sie 2-legged OAuth im Sicherheitsprofil konfigurieren (mithilfe der Einstellung 2-legged OAuth Flow) wählen Sie unter Client handelt in eigenem Namen die Option Client-Anmeldeinformationen aus.
- Wählen Sie unter Client, der im Auftrag eines Benutzers handelt Aktualisierungstoken aus.
-
Geben Sie die drei Anmelde-Umleitungs-URIs ein, die für Ihre Harmony-Organisation und Region geeignet sind:
-
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):
-
Geben Sie die
swagger-ui
Für Ihre Region geeigneter URI-Wert (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
- NA:
-
-
Löschen Sie die Abmelde-Umleitungs-URIs.
-
Löschen Sie unter Vertrauenswürdige Ursprünge die Basis-URIs.
-
Weisen Sie unter Zuweisungen die gewünschte Gruppe zu (wenn Sie Gruppenzuweisungen für Ihre App festlegen) oder belassen Sie die Standardeinstellung Jeder. Anweisungen zum Zuweisen der App-Integration zu einzelnen Benutzern und Gruppen finden Sie unter App-Integrationen zuweisen in der Okta Produktdokumentation.
-
-
Nachdem Sie auf Speichern geklickt haben, werden die Client-ID und das Client-Geheimnis auf der Tab Allgemein unter Client-Anmeldeinformationen angezeigt. 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 Okta als OAuth-Anbieter:
Geben Sie die Werte für OAuth-Client-ID und OAuth-Client-Geheimnis ein, die Sie im vorherigen Abschnitt Okta als Identitätsanbieter konfigurieren erhalten haben:
Bearbeiten Sie die OAuth-Autorisierungs URL, die OAuth-Token URL und die Benutzerinfo URL, um die Platzhalterdomäne (yourOktaDomain
) und der Platzhalter-Autorisierungsserver-ID (yourAuthServerId
) durch die für Ihre Okta-Instanz:
yourOktaDomain
: Ersetzen Sie durch die Okta-Domäne, auch Okta URL genannt. Siehe Finden Sie Ihre Okta-Domäne.yourAuthServerId
: Ersetzen Sie durch die ID des Okta Autorisierungsservers. Siehe Autorisierungsserver erstellen.
Wenn die Feldeingabe beispielsweise konfiguriert ist, sollte sie der hier gezeigten ähneln:
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 Okta OAuth 2.0-Authentifizierung konfigurierte Sicherheitsprofil aus.
4. Zugriff auf eine API mit Okta 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.
Wenn 3-legged OAuth 2.0 verwendet wird, leitet der Browser zur nativen Anmeldeoberfläche für Okta weiter. Geben Sie Ihre Anmeldeinformationen ein, um sich bei Okta zu authentifizieren.
Wenn die Authentifizierung erfolgreich ist, wird die erwartete Payload im Webbrowser angezeigt.