Informationen zu OAuth-Endpunkten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Um einen Job als OAuth2-Autorisierungsserver ausführen zu können, muss Apigee Edge Endpunkte verfügbar machen, bei denen Clients Tokens und Auth-Codes anfordern können. In diesem Thema wird eine kurze Einführung in diese Endpunkte vorgestellt. Außerdem erfahren Sie, wie Sie sie in Edge einrichten.

Was ist ein OAuth2-Endpunkt?

Ein OAuth2-Endpunkt ist eine URL, die Clients aufrufen können, um OAuth-Token (oder Authentifizierungscodes) anzufordern. Hier sehen Sie eine Beispielanfrage für ein Zugriffstoken:

$ curl -i -H 'ContentType: x-www-form-urlencoded' \
-X POST 'https://docs-test.apigee.net/oauth/client_credential/accesstoken' \
-d 'grant_type=client_credentials' \
-H 'Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ'

In Ihrer Apigee Edge-Umgebung ist eine Richtlinie zur Verarbeitung dieser Art von Anfrage erforderlich. Wie Sie aus der Anfrage ableiten können, muss die Richtlinie den Gewährungstyp "Clientanmeldedaten" unterstützen und die Richtlinie muss unter dem Pfad /oauth/client_credentials/accesstoken ausgeführt werden.

Die richtige Richtlinie in diesem Fall ist eine OAuthV2-Richtlinie, die zur Ausführung in einem Ablauf konfiguriert ist, wie im folgenden Beispiel.

        <Flow name="AccessTokenClientCredential">
            <Description/>
            <Request>
                <Step>
                    <FaultRules/>
                    <Name>GenerateAccessTokenClient</Name>
                </Step>
            </Request>
            <Response/>
            <Condition>(proxy.pathsuffix MatchesPath &quot;/accesstoken&quot;) and (request.verb = &quot;POST&quot;)</Condition>
        </Flow>

Wenn der Client die richtigen Anmeldeinformationen bereitstellt, generiert die Richtlinie ein Token und gibt es zurück. Andernfalls wird ein Fehler zurückgegeben.

Standardendpunkte ermitteln

Apigee fügt jeder neuen Organisation, die es erstellt, standardmäßig einen OAuth2-Endpunkt-Proxy-Proxy hinzu. In diesem Fall finden Sie in Ihrer Organisation einen Proxy namens oauth.

So finden Sie diesen Proxy:

  1. Rufen Sie die Seite mit den API-Proxys auf, wie unten beschrieben.

    Edge

    So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „API-Proxies“ zu:

    1. Melden Sie sich unter apigee.com/edge an.
    2. Wählen Sie in der linken Navigationsleiste Develop > API Proxies aus.
    3. Klicken Sie auf +Proxy.

    Classic Edge (Private Cloud)

    So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite API-Proxys zu:

    1. Melden Sie sich bei http://ms-ip:9000 an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist.
    2. Wählen Sie in der oberen Navigationsleiste APIs > API-Proxies aus.
  2. Wählen Sie in der Liste der Proxys den Proxy unter oauth aus.
  3. Wählen Sie auf der Übersichtsseite des Proxys den Tab Develop aus, um den Proxy-Editor aufzurufen, und prüfen Sie die Richtlinien und Abläufe im Proxy.

Best Practice: Benutzerdefinierten OAuth2-Endpunkt-Proxy erstellen

Der standardmäßige oauth-Proxy ist begrenzt: Er unterstützt nur die Gewährung von Clientanmeldedaten. Dieser Proxy ist nur als Beispiel vorgesehen. Für die Produktion möchten Sie einen Proxy erstellen, der die OAuth2-Endpunkte konfiguriert, die Ihren Anforderungen entsprechen.

Wichtiger Hinweis: Ein Proxy, der OAuth2-Endpunkte definiert, ist in der Regel kein No Zielproxy. Der Proxy fungiert als Dienst, der im ProxyEndpoint ausgeführt wird und direkt an den Client zurückgegeben wird.

Weitere Informationen

Zugriffstokens und Autorisierungscodes anfordern