Zum Inhalt springen

Okta 3-beinige OAuth 2.0 API-Sicherheitsprofil im Jitterbit API Manager

Einführung

Innerhalb eines Sicherheitsprofils kann Okta als OAuth 2.0-Identitätsanbieter konfiguriert werden, um API-Nutzern den Zugriff auf eine API mithilfe der Okta-Authentifizierung zu ermöglichen.

Diese Seite zeigt, wie Sie die Okta-Authentifizierung mit einer Jitterbit benutzerdefinierten, OData- oder Proxy-API konfigurieren und verwenden, indem Sie die folgenden Schritte ausführen:

  1. 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 zur Konfiguration eines Sicherheitsprofils im API Manager benötigen.
  2. Ein Sicherheitsprofil im API Manager konfigurieren
    Konfigurieren und testen Sie Okta als Identitätsanbieter im API Manager. Sie müssen die in Schritt 1 erhaltene Client-ID und das Client-Geheimnis verwenden.
  3. Ein Sicherheitsprofil im API Manager zuweisen
    Weisen Sie das Sicherheitsprofil einer oder mehreren Jitterbit benutzerdefinierten, OData- oder Proxy-APIs zu.
  4. Auf eine API mit Okta-Authentifizierung zugreifen
    API-Nutzer können dann die Okta-Authentifizierung verwenden, um Jitterbit benutzerdefinierte, OData- oder Proxy-APIs zu konsumieren, denen das Sicherheitsprofil zugewiesen ist.

Für weitere Informationen siehe die Okta-Dokumentation Überblick über OAuth 2.0 und OpenID Connect.

Für die Konfiguration des Okta 2-beinigen OAuth-Sicherheitsprofils siehe Okta 2-beiniges OAuth 2.0 API-Sicherheitsprofil.

1. Okta als Identitätsanbieter konfigurieren

  1. Melden Sie sich beim Okta Developer Console als Benutzer mit administrativen Rechten an.

  2. Navigieren Sie in Okta's Developer Console zu Applications > Applications und klicken Sie dann auf die Schaltfläche Create App Integration.

  3. Wählen Sie im Schritt Sign-in Method der Seite Create a New App Integration OIDC - OpenID Connect aus. Wählen Sie für den Application type Web Application und klicken Sie dann auf Next.

    attachment

  4. Konfigurieren Sie im Schritt General Settings der Seite New Web App Integration die Anmeldeinformationen für das Sicherheitsprofil:

    attachment

    1. Geben Sie einen App Integration Name ein (zum Beispiel Jitterbit API Manager APIs).

    2. Unter Grant type:

      1. Wenn Sie 2-beinigen OAuth im Sicherheitsprofil konfigurieren (indem Sie die Einstellung 2-legged OAuth Flow verwenden), wählen Sie Client Credentials unter Client acting on behalf of itself.
      2. Wählen Sie Refresh Token unter Client acting on behalf of a user.

    3. Geben Sie die drei Sign-in redirect URIs ein, die für Ihre Harmony-Organisation und Region geeignet sind:

      1. Geben Sie die beiden URI-Werte ein, die von der Sicherheitsprofil-Konfigurationsseite kopiert wurden (das Bild unten wurde zugeschnitten, um die relevanten Bereiche zu zeigen):

        attachment

        attachment

      2. Geben Sie den swagger-ui URI-Wert ein, der für Ihre Region geeignet ist (siehe Finding my region):

        • 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

    4. Löschen Sie die Sign-out redirect URIs.

    5. Unter Vertrauenswürdige Ursprünge die Basis-URIs löschen.

    6. Unter Zuweisungen die Gruppe zuweisen, die Sie möchten (wenn Sie Gruppen-Zuweisungen für Ihre App festgelegt haben) oder die Standardoption Jeder belassen. Für Anweisungen zur Zuweisung der App-Integration an einzelne Benutzer und Gruppen siehe App-Integrationen zuweisen in der Okta-Produktdokumentation.

  5. Nach dem Klicken auf Speichern werden die Client-ID und das Client-Geheimnis im Tab Allgemein unter Client-Anmeldeinformationen angezeigt. Bewahren Sie diese für die spätere Verwendung auf, da sie bei der Konfiguration des Sicherheitsprofils benötigt werden:

    attachment

2. Konfigurieren Sie ein Sicherheitsprofil im API-Manager

Konfigurieren Sie diese Felder für ein Sicherheitsprofil:

okta 2-legged

  • Auth-Typ: Wählen Sie OAuth 2.0.

  • OAuth-Anbieter: Wählen Sie Okta.

  • 2-beiniger OAuth-Flow: Lassen Sie dieses Feld deaktiviert.

  • Autorisierte Domains: Lassen Sie dieses Feld leer.

  • OAuth-Client-ID: Geben Sie optional die Client-ID aus Schritt 1 für Tests ein.

  • OAuth-Client-Geheimnis: Geben Sie optional das Client-Geheimnis aus Schritt 1 für Tests ein.

  • OAuth-Autorisierungs-URL: Ersetzen Sie {{ SUBDOMAIN }} durch die Okta-Domain, auch als Okta-URL bezeichnet (siehe Finden Sie Ihre Okta-Domain). Ersetzen Sie yourAuthServerId durch die ID des Okta-Autorisierungsservers (siehe Erstellen eines Autorisierungsservers).

  • OAuth-Token-URL: Ersetzen Sie {{ SUBDOMAIN }} durch die Okta-Domain, auch als Okta-URL bezeichnet (siehe Finden Sie Ihre Okta-Domain). Ersetzen Sie yourAuthServerId durch die ID des Okta-Authentifizierungsservers (siehe Erstellen eines Authentifizierungsservers).

  • Benutzerinformations-URL: Ersetzen Sie {{ SUBDOMAIN }} durch die Okta-Domain, auch als Okta-URL bezeichnet (siehe Finden Sie Ihre Okta-Domain). Ersetzen Sie yourAuthServerId durch die ID des Okta-Authentifizierungsservers (siehe Erstellen eines Authentifizierungsservers).

  • Testverbindung: Klicken Sie, um das Authentifizierungstoken zu validieren.

3. Weisen Sie ein Sicherheitsprofil im API-Manager zu

Um das Sicherheitsprofil mit einer API zu verwenden, folgen Sie den Anweisungen zur Konfiguration einer benutzerdefinierten API, OData-Dienst oder Proxy-API und wählen Sie das Sicherheitsprofil aus, das mit der Okta OAuth 2.0-Authentifizierung konfiguriert ist.

4. Greifen Sie mit Okta-Authentifizierung auf eine API zu

Sobald Sie eine benutzerdefinierte API, OData-Dienst oder Proxy-API gespeichert und veröffentlicht haben, ist ihre API über die URL in der Anwendung zugänglich, die die API mit der konfigurierten Authentifizierungsmethode aufruft.

Um die API zu konsumieren, verwenden Sie den Link zu URL kopieren und verwenden Sie ihn innerhalb der aufrufenden Anwendung:

url kopieren

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-beiniger OAuth 2.0 verwendet wird, leitet der Browser zur nativen Anmeldeschnittstelle von Okta weiter. Geben Sie Ihre Anmeldeinformationen ein, um sich bei Okta zu authentifizieren.

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