<ph type="x-smartling-placeholder"></ph>
Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur
Apigee X-Dokumentation. Weitere Informationen
Was
Löscht den angegebenen OAuth V2-Autorisierungscode oder -Zugriffstoken.
Beispiele
Zugriffstoken löschen
Im Folgenden finden Sie eine Beispielrichtlinie, die zum Löschen eines OAuth 2.0-Zugriffstokens verwendet wird. Im folgenden Beispiel wird das Zugriffstoken ermittelt, das in der Anfragenachricht gelöscht werden soll. Dazu wird nach einem Header namens access_token
gesucht.
<DeleteOAuthV2Info name="DeleteAccessToken"> <AccessToken ref="request.header.access_token"></AccessToken> </DeleteOAuthV2Info>
Autorisierungscode löschen
Die folgende Beispielrichtlinie dient zum Löschen eines OAuth 2.0-Autorisierungscodes. Das folgende Beispiel ermittelt den Autorisierungscode, der in der Anfragenachricht gelöscht werden soll. Dazu wird ein Abfrageparameter namens code
gesucht.
<DeleteOAuthV2Info name="DeleteAuthCode"> <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode> </DeleteOAuthV2Info>
Elementreferenz
Die Elementreferenz beschreibt die Elemente und Attribute der Richtlinie „DeleteOAuthV2Info”.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1"> <DisplayName>Delete OAuth v2.0 Info 1</DisplayName> <AccessToken ref={some-variable}></AccessToken> <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>--> <Attributes/> </DeleteOAuthV2Info
Attribute von <DeleteOAuthV2Info>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Attribut | Beschreibung | Standard | Präsenz |
---|---|---|---|
async |
Setzen Sie das Attribut auf Diese Einstellung wird nur für die interne Optimierung verwendet. |
falsch | Optional |
continueOnError |
Tritt ein Fehler auf, soll bei den meisten Richtlinien in der Regel eine Fehlermeldung zurückgegeben werden. Wenn Sie dieses Attribut auf |
false | Optional |
Aktiviert | Legt fest, ob eine Richtlinie durchgesetzt wird. Wenn dieses Attribut auf false festgelegt ist, wird eine Richtlinie deaktiviert und nicht durchgesetzt, obwohl die Richtlinie mit einem Ablauf verknüpft bleibt. |
wahr | Optional |
name |
Der interne Name der Richtlinie. Auf diesen Namen wird in Step-Elemente verwiesen, um die Richtlinie an einen Ablauf anzuhängen. Hinweis: Sie können im Namen nur die folgenden Zeichen verwenden: |
– | Erforderlich |
Element <AccessToken>
Gibt die Variable an, in der sich das zu löschende Zugriffstoken befindet. Wenn das Zugriffstoken beispielsweise als Abfrageparameter "access_token" an die Anfragenachricht angehängt ist, geben Sie request.queryparam.access_token
an. Sie können jede gültige Variable verwenden, die auf das Token verweist. Alternativ könnte der literalen Tokenstring verwendet werden (selten).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Standardwert: | – |
Präsenz: | <AccessToken> oder <AuthorizationCode> ist erforderlich. |
Typ: | String |
Attribute
Attribut | Beschreibung | Standard | Präsenz |
---|---|---|---|
ref |
Eine Variable für das Zugriffstoken. Wird normalerweise aus einer Ablaufvariablen abgerufen. Beispiel: |
– | Optional |
Element <AuthorizationCode>
Gibt die Variable an, in der sich der zu löschende Autorisierungscode befindet. Wenn der Authentifizierungscode beispielsweise als Abfrageparameter "code" an die Anfragenachricht angehängt ist, geben Sie request.queryparam.code
an. Sie können jede gültige Variable verwenden, die auf das Token verweist.
Alternativ könnte der literalen Tokenstring verwendet werden (selten).
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Standardwert: | – |
Präsenz: | <AccessToken> oder <AuthorizationCode> ist erforderlich. |
Typ: | String |
Attribute
Attribut | Beschreibung | Standard | Präsenz |
---|---|---|---|
ref |
Eine Variable für das Zugriffstoken. Wird normalerweise aus einer Ablaufvariablen abgerufen. Beispiel: |
– | Optional |
Element <DisplayName>
Ein Name in natürlicher Sprache, der die Richtlinie im Proxy-Editor der Verwaltungsoberfläche kennzeichnet. Wenn nicht angegeben, wird das Attribut für den Richtliniennamen verwendet.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Standardwert: | Der Wert des Attributs name der Richtlinie. |
Präsenz: | Optional |
Typ: | String |
Fehlerreferenz
Dieser Abschnitt beschreibt die Fehlercodes und Fehlermeldungen, die zurückgegeben werden, und die Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.
Laufzeitfehler
Diese Fehler können bei Ausführung der Richtlinie auftreten.
Fehlercode | HTTP-Status | Ursache |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 | Das an die Richtlinie gesendete Zugriffstoken ist ungültig. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 | Der an die Richtlinie gesendete Autorisierungscode ist ungültig. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 | Weitere Informationen zur Fehlerbehebung bei diesem Fehler finden Sie in diesem Apigee Community-Post. |
Bereitstellungsfehler
Informationen zu Bereitstellungsfehlern finden Sie in der Benutzeroberfläche, die in der Benutzeroberfläche angezeigt wird.
Fehlervariablen
Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst.
Variablen | Wo | Beispiel |
---|---|---|
fault.name="fault_name" |
fault_name ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes. | fault.name = "invalid_access_token" |
oauthV2.policy_name.failed |
policy_name ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat. | oauthV2.DeleteTokenInfo.cause = Invalid Access Token |
Beispiel für eine Fehlerantwort
{ "fault": { "faultstring": "Invalid Access Token", "detail": { "errorcode": "keymanagement.service.invalid_access_token" } } }
Beispiel für eine Fehlerregel
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults"> <Step> <Name>AM-InvalidTokenResponse</Name> </Step> <Condition>(fault.name = "invalid_access_token")</Condition> </FaultRule>
Schema
Jeder Richtlinientyp wird durch ein XML-Schema (.xsd
) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.