Informationen zu OAuth-Endpunkten

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Um einen Job als OAuth2-Autorisierungsserver ausführen zu können, muss Apigee 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 Apigee 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://apitest.acme.com/oauth/client_credential/accesstoken" \
-d "grant_type=client_credentials" \
-H "Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

Sie benötigen eine OAuthV2-Richtlinie, um diese Anfrage zu verarbeiten. Wie Sie anhand der obigen Beispielanfrage ableiten können, muss die Richtlinie den Berechtigungstyp „Clientanmeldedaten” unterstützen und für den Pfad /oauth/client_credentials/accesstoken ausgeführt werden.

Dies ist ein Beispiel für eine OAuthV2-Richtlinie, die für die Annahme des Berechtigungstyps client_credentials konfiguriert ist. Informationen zu optionalen Konfigurationselementen, die mit dieser Richtlinie konfiguriert werden können, finden sich unter OAuthV2-Richtlinie.

<OAuthV2 name="GenerateAccessToken">
    <Operation>GenerateAccessToken</Operation>
    <ExpiresIn>1800000</ExpiresIn> <!-- 30 minutes -->
    <SupportedGrantTypes>
      <GrantType>client_credentials</GrantType>
    </SupportedGrantTypes>
    <GenerateResponse enabled="true"/>
</OAuthV2>

Dies ist ein Beispiel für die Endpunktkonfiguration zum Generieren eines Zugriffstoken. Es führt die Richtlinie "GenerateAccessToken" aus, die für die Unterstützung des Grant-Typs "client_credentials" konfiguriert sein muss.

...
       <Flow name="generate-access-token">
            <Request>
                <Step>
                    <Name>GenerateAccessToken</Name>
                </Step>
            </Request>
            <Response/>
            <Condition>(proxy.pathsuffix MatchesPath "/token") and (request.verb = "POST")</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.

Weitere Informationen

Ausführliche Informationen zu allen unterstützten Berechtigungstypen und Beispielcode finden Sie unter OAuth 2.0-Tokens abrufen.