Usuń OAuthV2Informacje

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Informacje | Przykłady | Odniesienie do elementu | Wyniki | Schemat | Powiązane artykuły

Co

Usuwa określony kod autoryzacji lub token dostępu OAuth V2.

Przykłady

Usuwanie tokena dostępu

Poniżej znajdziesz przykład zasady używanej do usuwania tokena dostępu OAuth 2.0. Poniższy przykład znajduje token dostępu do usunięcia w wiadomości żądania, wyszukując nagłówek o nazwie access_token.

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

Poniżej znajdziesz przykład zasady używanej do usuwania kodu autoryzacji OAuth 2.0. Poniższy przykład znajduje kod autoryzacji do usunięcia w wiadomości żądania, wyszukując parametr zapytania o nazwie code.

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

Odniesienie do elementu

Odniesienie do elementu opisuje elementy i atrybuty zasady DeleteOAuthV2Info policy.

<?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

Atrybuty <DeleteOAuthV2Info>

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Atrybut Opis Domyślny Obecność
async

Ustaw na true, aby określić, że zasada ma być uruchamiana w puli wątków innej niż pula obsługująca przepływ żądania/odpowiedzi. Domyślnie jest false.

To ustawienie jest używane tylko do optymalizacji wewnętrznej.

 fałsz Opcjonalny
continueOnError

Większość zasad powinna zwracać błąd w przypadku niepowodzenia. Ustawienie tego atrybutu na true powoduje, że wykonanie przepływu jest kontynuowane w przypadku niepowodzenia.

 fałsz Opcjonalny
enabled Określa, czy zasada jest egzekwowana. Jeśli ustawisz wartość false, zasada zostanie „wyłączona” i nie będzie egzekwowana (nawet jeśli pozostanie dołączona do przepływu). prawda Opcjonalny
name

Wewnętrzna nazwa zasady. Ta nazwa jest używana w elementach Step do dołączania zasady do przepływu.

Uwaga: w nazwie można używać tylko tych znaków: A-Z0-9._\-$ %. Interfejs zarządzania wymusza dodatkowe ograniczenia, np. automatycznie usuwa znaki, które nie są alfanumeryczne.

 Nie dotyczy Wymagane

Element <AccessToken>

Określa zmienną, w której znajduje się token dostępu do usunięcia. Jeśli na przykład token dostępu jest dołączony do wiadomości żądania jako parametr zapytania o nazwie „access_token”, określ request.queryparam.access_token. Możesz użyć dowolnej prawidłowej zmiennej, która odwołuje się do tokena. Możesz też przekazać literał tokena (rzadki przypadek).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Domyślny: Nie dotyczy
Obecność: Wymagany jest element <AccessToken> lub <AuthorizationCode>.
Typ: Ciąg znaków

Atrybuty

Atrybut Opis Domyślny Obecność
ref

Zmienna tokena dostępu. Zazwyczaj pobierana ze zmiennej przepływu. Na przykład: request.header.token lub request.queryparam.token.

 Nie dotyczy Opcjonalny

Element <AuthorizationCode>

Określa zmienną, w której znajduje się kod autoryzacji do usunięcia. Jeśli na przykład kod autoryzacji jest dołączony do wiadomości żądania jako parametr zapytania o nazwie „code”, określ request.queryparam.code. Możesz użyć dowolnej prawidłowej zmiennej, która odwołuje się do tokena. Możesz też przekazać literał tokena (rzadki przypadek).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Domyślny: Nie dotyczy
Obecność: Wymagany jest element <AccessToken> lub <AuthorizationCode>.
Typ: Ciąg znaków

Atrybuty

Atrybut Opis Domyślny Obecność
ref

Zmienna tokena dostępu. Zazwyczaj pobierana ze zmiennej przepływu. Na przykład: request.header.code lub request.queryparam.code.

 Nie dotyczy Opcjonalny

Element<DisplayName>

Nazwa w języku naturalnym, która etykietuje zasadę w edytorze proxy w interfejsie zarządzania. Jeśli ten element zostanie pominięty, używany jest atrybut nazwy zasady.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Domyślny: Wartość atrybutu name zasady.
Obecność: Opcjonalny
Typ: Ciąg znaków

Wyniki

W przypadku powodzenia zasada zwraca stan 200.

W przypadku niepowodzenia zasada zwraca kod 404 i dane wyjściowe podobne do tych (w zależności od tego, czy usuwasz token dostępu, czy kod autoryzacji):

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"}}}

Schemat

Każdy typ zasady jest zdefiniowany przez schemat XML (.xsd). Schematy zasad są dostępne na GitHub.

Powiązane artykuły