OAuth-Provider eines Drittanbieters konfigurieren
Geben Sie die sicheren Endpunkte ein, um die OAuth-Authentifizierung von einem Drittanbieter bereitzustellen.
Informationen zu dieser Task
Für die Konfiguration von OAuth-Providern ist eine der folgenden Rollen erforderlich:
- Organisationsadministrator
- Eigner
- Angepasste Rolle mit den Berechtigungen Einstellungen > Verwalten
Vorgehensweise
- Klicken Sie in API Managerauf
Ressourcen. - Wählen Sie OAuth-Provider > Hinzufügen > OAuth-Provider eines anderen Anbietersaus.
- Geben Sie die folgenden Parameter für die erste Anzeige ein und klicken Sie auf Weiter.
Feld Beschreibung Titel Geben Sie einen beschreibenden Titel für den Gateway-Service ein. Dieser Titel wird auf dem Bildschirm angezeigt. Ihren Namen Dieses Feld wird automatisch vom System ausgefüllt und als interner Feldname verwendet. Unterstützte Erteilungstypen Wählen Sie eine der folgenden Optionen aus: - Implizit - Ein Zugriffstoken wird sofort ohne einen zusätzlichen Schritt zum Berechtigungscodeaustausch zurückgegeben.
- Anwendung: Anwendung zu Anwendung. Entspricht dem OAuth-Erteilungstyp "Clientberechtigungsnachweise". Es ist keine Benutzersicherheit erforderlich.
- Zugriffscode - Ein Berechtigungscode wird aus einer URL extrahiert und durch einen Zugriffscode ersetzt. Entspricht dem Oauth-Erteilungstyp "Berechtigungscode".
- Ressourceneigentümer - Kennwort : Der Client tauscht den Benutzernamen und das Kennwort des Benutzers direkt gegen ein Zugriffstoken aus, und nur Erstanbieter-Clients können diesen Fluss nutzen.
Ressourceneigner-JWT: Ein JWT-Trägertoken (JSON Web Token) wird als Mittel für die Anforderung eines OAuth 2.0 -Zugriffstokens und für die Clientauthentifizierung verwendet, wie im JWT-Profil (JSON Web Token) für OAuth 2.0 Client Authentication and Authorization Grantsdefiniert.Hinweis: Führen Sie die folgenden Schritte aus, wenn Sie die Option Resource owner-JWT verwenden möchten:- Wählen Sie im Feld Unterstützte Erteilungstypen sowohl Ressourceneigner-Kennwort als auch Ressourceneigner-JWTaus.
- Bearbeiten Sie die API-Definition und fügen Sie ein Sicherheitsschema hinzu, das oauth2 als Sicherheitsdefinitionstyp angibt, und wählen Sie Ressourceneigner-Kennwort als Ablauftyp aus.
Anweisungen zum Definieren eines OAuth2 -Sicherheitsschemas für eine API finden Sie unter OAuth2 -Sicherheitsschemakomponenten definieren (OpenAPI 3) oder OAuth2 -Sicherheitsschemas definieren (OpenAPI 2).
Gateway-Typ Wählen Sie den Gateway-Typ DataPower® API Gatewayaus. - Geben Sie Konfigurationseinstellungen für die Endpunkte an und klicken Sie anschließend auf Weiter.
Feld Beschreibung Berechtigungs-URL Eine Berechtigungs-URL, mit der der Ressourceneigner der Clientanwendung die Berechtigung für den Zugriff auf eine geschützte Ressource erteilt. Beispiel:
https://example.com/oauth2/authorizeToken-URL Eine Tokenanforderungs-URL, mit der die Clientanwendung eine Berechtigungserteilung gegen ein Zugriffstoken austauscht. Beispiel:
https://example.com/oauth2/tokenIntrospektions-URL Die Introspektions-URL ist der Ort, an dem das API-Gateway die Zugriffstokens überprüft, die vom Provider des Drittanbieters ausgegeben werden. Beispiel:
Weitere Informationen zur Integration von OAuth-Providern anderer Anbieter für die Introspektion finden Sie unter OAuth-Introspektion für OAuth-Provider anderer Anbieter.https://example.com/oauth2/introspect
IntrospektionscachetypDer Cachetyp bestimmt, wie lange Antworten vom Drittanbieter in den Cache gestellt werden, wenn überhaupt. Wählen Sie eine der folgenden Optionen aus: - Kein Cache (Standardwert): Die Antworten werden nicht im Cache gespeichert.
- Protokoll: Wird durch den
cache-control-Header in der Providerantwort definiert. - Time to live: Definiert durch den Provider.
CachelebensdauerDer Zeitraum in Sekunden, für den die Providerantworten im Cache gespeichert werden, wenn der Introspect-Cachetyp auf Time to livegesetzt ist. Der Standardwert ist 900. TLS-Profil (optional) Wählen Sie ein optionales TLS-Profil für die Kommunikation mit dem Drittanbieterprovider aus. Sicherheit Der Standard ist die Basisauthentifizierung. Name des Anforderungsheaders für Basisauthentifizierung Der Header x-introspect-basic-authorization-header ist verfügbar, um einen benutzerkonfigurierten HTTP-Basis-Berechtigungsheader bereitzustellen.
Benutzername für Basisauthentifizierung
(optional)Der Standard-Benutzername für die HTTP Basic-Authentifizierung.
Kennwort für Basisauthentifizierung (optional)Das Standardkennwort für die HTTP-Basisauthentifizierung.
TokenvalidierungGibt die Methode an, die verwendet wird, um den Erfolg der Introspektionsanforderung zu bestimmen, die an den Drittanbieterservice gesendet wird, um das angegebene Token zu validieren. Wählen Sie eine der folgenden Optionen aus: - Verbunden: Die Abfrage ist erfolgreich, wenn der Statusrückkehrcode
200ist. - Aktiv (Standardwert): Die Abfrage ist erfolgreich, wenn der Statusrückkehrcode
200lautet und der JSON-Antworthauptteil die Eigenschaftactive: trueenthält.
Angepasstes Headermuster (optional)Ein regulärer Ausdruck für Anforderungsheader, die an den Drittanbieter übergeben werden sollen, z. B. x-Introspect-*.
Berechtigungsheader durchlaufenAktivieren Sie dieses Kontrollkästchen, wenn Sie den AuthorizationHeader für ein Bearer Token beibehalten wollen. Standardmäßig wird dieser Header entfernt. - Geben Sie die Bereiche in der dritten Anzeige ein. Ein Bereich wird zu einer Option
in der Anforderung und zur Antwort für ein Zugriffstoken. Klicken Sie auf
Hinzufügen, um zusätzliche Felder für Bereiche hinzuzufügen. Klicken Sie abschließend auf Weiter .
Feld Beschreibung sample_scope_1 Bereich für Token sample_scope_2 Bereich für Token zusätzliche Bereiche Bereich für Token - Überprüfen Sie die Einstellungen in der Anzeige Zusammenfassung .
- Geben Sie die folgenden Parameter für die erste Anzeige ein und klicken Sie auf Weiter.
- Klicken Sie auf Speichern und bearbeiten , um die Konfiguration abzuschließen.