OAuth 2.0: Neuen API-Proxy konfigurieren

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Mit dem Berechtigungstyp "Clientanmeldedaten" wird ein Verfahren zur Ausgabe von Zugriffstokens im Austausch für Anwendungsanmeldedaten festgelegt. Diese Anwendungsanmeldedaten sind das Consumer-Schlüssel und Secret-Paar, das Apigee für jede in einer Organisation registrierte Anwendung ausgibt. Weitere Informationen finden Sie unter Typ der Autorisierungscode-Zuweisung implementieren.

OAuth 2.0 zu einem neuen API-Proxy hinzufügen

Sie können die OAuth-Überprüfung zu einer API hinzufügen, wenn Sie einen neuen API-Proxy in der Apigee-Benutzeroberfläche erstellen.

So fügen Sie einer API die OAuth-Überprüfung hinzu:

Apigee in der Cloud Console

  1. Rufen Sie in der Google Cloud Console die Seite Proxy-Entwicklung > API-Proxys auf.

    Zu „API-Proxys“

  2. Wählen Sie Ihre Organisation in der Projektauswahl im Bereich  Google Cloud aus. Der Name der Organisation entspricht dem Namen Ihres Google Cloud -Projekts.
  3. Klicken Sie im Bereich API-Proxys auf + Erstellen.
  4. Wählen Sie im Bereich Proxy erstellen unter Proxy-Vorlage die Option Reverse-Proxy (häufigste Quelle) aus.
  5. Konfigurieren Sie den Proxy so:
    Name Wert
    Proxy-Name helloworld_oauth2
    Basispfad

    /hellooauth2

    Der Projektbasispfad ist Teil der URL, die für Anfragen an den API-Proxy verwendet wird.
    Beschreibung hello world protected by OAuth v2.0
    Ziel (vorhandene API)

    https://mocktarget.apigee.net/ip

    Dies definiert die Ziel-URL, die Apigee für eine Anfrage an den API-Proxy aufruft. Dieses Ziel gibt einfach eine einfache Antwort zurück: Hello, Guest!.
  6. Klicken Sie auf Weiter.
  7. Bereitstellen (optional):
    • Bereitstellungsumgebungen: Optional. Wählen Sie durch die Kästchen eine oder mehrere Umgebungen aus, in denen Sie Ihren Proxy bereitstellen möchten. Wenn Sie den Proxy zu diesem Zeitpunkt nicht bereitstellen möchten, lassen Sie das Feld Bereitstellungsumgebungen leer. Sie können den Proxy später jederzeit bereitstellen.
    • Dienstkonto: (optional) Hängen Sie ein Dienstkonto an Ihre Bereitstellung an, damit der Proxy auf Google Cloud-Dienste zugreifen kann, wie in der Rolle und den Berechtigungen des Dienstkontos angegeben.
  8. Klicken Sie auf Erstellen.
  9. Klicken Sie im Bereich Proxy summary für den Proxy helloworld_apikey auf den Tab Develop.
  10. Klicken Sie im Menü Richtlinien auf Richtlinie hinzufügen.
  11. Wählen Sie im Bereich Richtlinie erstellen unter Sicherheit die Option API-Schlüssel überprüfen aus.
  12. Füllen Sie im Bereich API-Schlüssel bestätigen die erforderlichen Felder in den Abschnitten Name und Anzeigename mit den folgenden Werten aus:
    • Name: Geben Sie einen Richtliniennamen ein. Beispiel: VerifyAPIKey.
    • Anzeigename: Geben Sie den Namen der Richtlinie ein, der in der Benutzeroberfläche verwendet werden soll. Beispiel: Verify API Key.
  13. Klicken Sie auf Erstellen.
  14. Klicken Sie auf , um eine weitere Richtlinie hinzuzufügen.
  15. Wählen Sie im Bereich Richtlinie erstellen unter Vermittlung die Option Mitteilung zuweisen aus.
  16. Füllen Sie im Bereich Mitteilung zuweisen die erforderlichen Felder in den Abschnitten Name und Anzeigename mit den folgenden Werten aus:
    • Name: Geben Sie einen Richtliniennamen ein. Beispiel: AssignMessage.
    • Anzeigename: Geben Sie den Namen der Richtlinie ein, der in der Benutzeroberfläche verwendet werden soll. Beispiel: Assign Message.
  17. Klicken Sie auf Erstellen.

  18. Aktualisieren Sie den Inhalt der Richtlinie Nachricht zuweisen auf Folgendes:

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. Fügen Sie die Richtlinien VerifyApiKey und Remove Header Authorization hinzu.
    1. Klicken Sie im Menü Proxy Endpoints auf Preflow.
    2. Klicken Sie im Bereich Anfrage des visuellen Editors auf  Richtlinienschritt hinzufügen.
    3. Wählen Sie im Bereich Richtlinienschritt hinzufügen die Option API-Schlüssel überprüfen aus.
    4. Klicken Sie auf Hinzufügen.
    5. Klicken Sie im Bereich Anfrage des visuellen Editors auf  Richtlinienschritt hinzufügen.
    6. Wählen Sie im Bereich Richtlinienschritt hinzufügen die Option Header-Autorisierung entfernen aus.
    7. Klicken Sie auf Hinzufügen.
  20. Klicken Sie auf Speichern.

Klassische UI

  1. Melden Sie sich in der Apigee-Benutzeroberfläche an.
  2. Wählen Sie in der linken Navigationsleiste Develop > API Proxies aus.
  3. Klicken Sie auf +Proxy.
  4. Mit dem Assistenten "Proxy erstellen" können Sie einen Reverse-Proxy erstellen. Siehe Einfachen API-Proxy erstellen.
  5. Klicken Sie auf der Seite Allgemeine Richtlinien des Assistenten auf das Optionsfeld neben OAuth v2.0.
1 neu erstellten API-Proxy zwei Richtlinien angehängt: eine zum Prüfen der Zugriffstokens und eine weitere, um das Zugriffstoken nach der Bestätigung zu entfernen.

Das Kästchen API-Produkt veröffentlichen ist auswählbar und wird automatisch ausgewählt. Klicken Sie dieses Kästchen an, wenn ein Produkt beim Erstellen des neuen API-Proxys automatisch generiert werden soll. Das automatisch erzeugte Produkt wird mit einer Verknüpfung zum neuen API-Proxy erstellt. Wenn Sie bereits ein Produkt haben, mit dem Sie diese neue API verknüpfen möchten, entfernen Sie das Häkchen aus diesem Kästchen, damit Sie kein unnötiges Produkt erstellen. Informationen zu Produkten finden Sie unter Was ist ein API-Produkt?