Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info
Willkommen auf der Startseite für OAuth in Apigee Edge. Auf dieser Landingpage finden Sie Links zu Dokumentation, Beispielen und anderen Ressourcen zur Verwendung von OAuth in Apigee Edge.
Das OAuth 2.0-Framework
APIs mit OAuth 2.0 schützen In diesem Abschnitt finden Sie Ressourcen, Beispielcode, Videos und andere Themen, die Ihnen helfen, OAuth 2.0 in Apigee Edge erfolgreich zu verwenden.
Informationen zu OAuth 2.0
Mit diesen Ressourcen finden Sie schnell den Einstieg in OAuth 2.0.
- Apigee Dokumentation:
- Einführung in OAuth 2.0: – grundlegende OAuth 2.0-Konzepte und -Bedingungen. Der Fokus liegt auf der Verwendung von OAuth auf Apigee Edge.
- Apigee-Schulungen und -Zertifizierungen:
- Apigee bietet Onlineschulungen für API-Entwickler, einschließlich eines Kurses zur API-Sicherheit, die OAuth enthält.
- IETF-Spezifikation:
- IETF-Spezifikation: Apigee empfiehlt Ihnen, diese Spezifikation zu lesen. Sie enthält eine gute grundlegende Einführung und eine Konzeptübersicht.
- E-Book und Video von Apigee:
- OAuth the Big Picture: kostenloses Apigee-E-Book
- OAuth the Big Image: kostenloser Apigee-Webcast
Flüsse zu Berechtigungstypen implementieren
Apigee bietet Arbeitsbeispiele für die einzelnen OAuth 2.0-Berechtigungstypen, um Ihnen den Einstieg zu erleichtern. Die Beispiele sind Best Practices und zeigen, wie Sie OAuth-Berechtigungstypen in Apigee Edge implementieren.
Clientanmeldedaten
- Berechtigungstyp für Clientanmeldedaten implementieren: bietet die Art der Gewährung. Dabei liegt der Fokus auf den Schritten, die Sie ausführen müssen, um diese Art von Berechtigung in Apigee Edge zu implementieren.
- Beispielimplementierung – Schauen Sie sich dieses Beispiel in unserem API-Beispielrepository auf GitHub an.
- API-Sicherheit (enthält OAuth)
Autorisierungscode
- Berechtigungstyp für Autorisierungscode implementieren: stellt den Berechtigungstyp vor. In erster Linie geht es darum, wie Sie diesen Berechtigungstyp auf Apigee Edge implementieren können.
- Beispielimplementierung: Schauen Sie sich dieses erweiterte Beispiel in unserem API-Beispielrepository auf GitHub an. Sie können das Beispiel klonen, bereitstellen und ausführen. Weitere Informationen finden Sie in der README-Datei. Sie enthält eine robuste Anmeldeanwendung, die Nutzer authentifiziert und sicher mit dem Autorisierungsserver kommuniziert.
Implizit
- Tokens anfordern: impliziter Berechtigungstyp: zeigt an, wie Tokens mit dem impliziten Berechtigungstyp angefordert werden.
Anmeldedaten für Ressourceninhaberpasswörter
- Berechtigungstyp für Passwörter implementieren: implementiert den Berechtigungstyp. Der Fokus liegt dabei auf den Schritten, die Sie zur Implementierung dieses Berechtigungstyps auf Apigee Edge ausführen müssen.
Schnelle Anleitungen
Diese Themen geben Ihnen einen schnellen Kontext sowie Informationen zu den Schritten für die Handhabung häufiger OAuth 2.0-Aufgaben:
- Neuen API-Proxy konfigurieren
- Client-Apps registrieren
- Clientanmeldedaten abrufen
- OAuth-Endpunkte und -Richtlinien konfigurieren
- Tokens und Auth-Codes anfordern
- Zugriffstokens anpassen
- Zugriffstokens genehmigen und widerrufen
- Zugriffstoken senden
- Zugriffstokens prüfen
- Mit Bereichen arbeiten
- Weiterführende Informationen
Richtlinien- und API-Referenzen
In diesen Themen finden Sie detaillierte Referenzinformationen zu den Richtlinien und APIs, die OAuth 2.0 in Edge direkt unterstützen.
- OAuthV2-Richtlinien: Mit diesen Richtlinien können Sie die vier OAuth 2.0-Berechtigungstypen auf Apigee Edge implementieren und anpassen:
- OAuthV2-Richtlinie: Das Herzstück der Apigee Edge-Implementierung von OAuth 2.0. Damit können Sie OAuth 2.0-Vorgänge in Apigee Edge konfigurieren, mit denen Zugriffstokens und Aktualisierungstokens generiert, Autorisierungscodes ausgestellt und Tokens validiert werden. Dieses Thema enthält Codebeispiele, die die Funktionsweise veranschaulichen.
- GetOAuthV2Info-Richtlinie: Ruft Attribute von Tokens ab und stellt sie für Richtlinien und Code zur Verfügung, die in einem API-Proxy ausgeführt werden. Dieser Richtlinientyp kann nützlich sein, wenn Sie dynamisches, bedingtes Verhalten basierend auf einem Wert in einem Zugriffstoken konfigurieren müssen. Weitere Informationen finden Sie unter Zugriffstokens anpassen.
- SetOAuthV2Info-Richtlinie: Aktualisiert das Profil eines Zugriffstokens. Sie können beispielsweise ein Tag einbetten, das für Ihr Unternehmen eindeutig ist. Weitere Informationen finden Sie unter Zugriffstokens anpassen.
- OAuth 2.0-Fehlercodes
- OAuth 2.0 APIs: Apigee stellt diese APIs für die Arbeit mit OAuth 2.0-Endpunkten bereit.
Das OAuth 1.0-Framework
OAuth 1.0a definiert ein Standardprotokoll, mit dem App-Nutzer Apps autorisieren können, APIs in ihrem Namen zu nutzen, ohne dass sie ihr Passwort an die App weitergeben müssen.
Referenz zu OAuth 1.0a-Richtlinien
Die Unterstützung für OAuth 1.0a wurde eingestellt. Weitere Informationen finden Sie unter Verworfene Funktionen. Der OAuthV1-Richtlinientyp ist für das Generieren von Anforderungstokens, das Generieren von Zugriffstokens und das Überprüfen von Zugriffstokens auf Grundlage der OAuth 1.0a-Spezifikation zuständig.
OAuth 1.0a APIs
Apigee bietet APIs für die Arbeit mit OAuth 1.0a-Endpunkten.
Beispiel für OAuth 1.0a auf GitHub
Dieser Beispiel-API-Proxy auf GitHub veranschaulicht eine dreibeinige Konfiguration von OAuth 1.0a. Sie können diesen Code herunterladen und ausführen.
| Name | Beschreibung |
|---|---|
| oauth10a-3legged | Veranschaulicht eine dreibeinige OAuth-Konfiguration. |