DeleteOAuthV2Info

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

Info | Beispiele | Elementreferenz | Ausgabe | Schema | Weitere Informationen

Was

Löscht den angegebenen OAuth V2-Autorisierungscode oder -Zugriffstoken.

Samples

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 zu löschende Zugriffstoken in der Anfragenachricht ermittelt. Dazu wird nach einem Header namens access_token gesucht.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

Die folgende Beispielrichtlinie dient zum Löschen eines OAuth 2.0-Autorisierungscodes. Im folgenden Beispiel wird der zu löschende Autorisierungscode in der Anfragenachricht ermittelt. Dazu wird nach einem 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 true, um anzugeben, dass die Richtlinie in einem anderen Thread-Pool als dem Pool ausgeführt werden soll, der den Anfrage/Antwort-Fluss verarbeitet. Der Standardwert ist false.

Diese Einstellung wird nur für die interne Optimierung verwendet.

 false Optional
continueOnError

Tritt ein Fehler auf, soll bei den meisten Richtlinien in der Regel eine Fehlermeldung zurückgegeben werden. Wenn Sie dieses Attribut auf true setzen, wird der Ablauf bei einem Fehler weiter ausgeführt.

 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. true 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: A-Z0-9._\-$ %. Die Verwaltungs-UI erzwingt zusätzliche Einschränkungen, z. B. werden nicht alphanumerische Zeichen automatisch entfernt.

 – 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: request.header.token oder request.queryparam.token.

 – 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).

 <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: request.header.code oder request.queryparam.code.

 – Optional

Element <DisplayName>

Ein Name in natürlicher Sprache, mit dem die Richtlinie im Proxy-Editor der Verwaltungs-UI bezeichnet wird. 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

Ausgabe

Bei Erfolg gibt die Richtlinie den Status 200 zurück.

Bei einem Fehler gibt die Richtlinie 404 und eine Ausgabe ähnlich der folgenden zurück (je nachdem, ob Sie ein Zugriffstoken oder einen Authentifizierungscode löschen):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

Schema

Jeder Richtlinientyp wird durch ein XML-Schema (.xsd) definiert. Zu Referenzzwecken sind Richtlinienschemas auf GitHub verfügbar.

Weitere Informationen