Usuń OAuthV2Informacje

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Informacje | Próbki | Element odniesienie | Dane wyjściowe | Schemat | Powiązane artykuły

Co

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

Przykłady

Usuń token dostępu

Poniżej znajdziesz przykładową zasadę usuwania tokena dostępu OAuth 2.0. Przykład poniżej znajduje token dostępu do usunięcia z 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ładową zasadę usuwania kodu autoryzacji OAuth 2.0. Przykład poniżej znajduje kod autoryzacji do usunięcia z wiadomości z żądaniem, wyszukując parametr zapytania pod tytułem code.

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

Odniesienie do elementu

Dokumentacja elementu opisuje elementy i atrybuty metody 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

<DeleteOAuthV2Info> atrybuty

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

Ustaw jako true, aby określić, że zasada ma być uruchamiana w wątku pula inna niż pula obsługująca przepływ żądań/odpowiedzi. Domyślne jest false.

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

 fałsz Opcjonalnie
continueOnError

Większość zasad powinna zwracać błąd w przypadku wystąpienia błędu. Ustawienie true, w przypadku niepowodzenia wykonywanie przepływu będzie kontynuowane.

 fałsz Opcjonalnie
włączone Określa, czy zasada jest egzekwowana. Jeśli ma wartość false, jest „wyłączona” i nie jest egzekwowana (mimo że jest przepływu). prawda Opcjonalnie
nazwa

Wewnętrzna nazwa zasady. Do tej nazwy odwołują się elementy kroku, które należy dołączyć do przepływu.

Uwaga: w nazwie można używać tylko następujących znaków: A-Z0-9._\-$ % Interfejs zarządzania wymusza dodatkowe ograniczenia, takie jak: automatycznie usuwa znaki niealfanumeryczne.

 Nie dotyczy Wymagane

&lt;AccessToken&gt; element

Identyfikuje zmienną, w której znajduje się token dostępu do usunięcia. Na przykład, jeśli plik token dostępu jest dołączony do komunikatu żą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 token. Można też przekazać ciąg tokena literału (rzadkie litery).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Domyślne: Nie dotyczy
Obecność: Dozwolone wartości <AccessToken> albo <AuthorizationCode>
Typ: Ciąg znaków

Atrybuty

Atrybut Opis Domyślny Obecność
odsyłacz

Zmienna tokena dostępu. Wartość jest zwykle pobierana ze zmiennej przepływu. Dla: przykład: request.header.token lub request.queryparam.token.

 Nie dotyczy Opcjonalnie

&lt;AuthorizationCode&gt; element

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Domyślne: Nie dotyczy
Obecność: Dozwolone wartości <AccessToken> albo <AuthorizationCode>
Typ: Ciąg znaków

Atrybuty

Atrybut Opis Domyślny Obecność
odsyłacz

Zmienna tokena dostępu. Wartość jest zwykle pobierana ze zmiennej przepływu. Dla: przykład: request.header.code lub request.queryparam.code.

 Nie dotyczy Opcjonalnie

&lt;DisplayName&gt; element

Nazwa w języku naturalnym oznaczająca zasadę w edytorze proxy interfejsu zarządzania. Jeśli zostanie pominięty, jest używany atrybut nazwa zasady.

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

Wyniki

Jeśli operacja się uda, zasada zwraca stan 200.

W przypadku niepowodzenia zasada zwraca kod 404 i wyświetla wyniki podobne do tych (w zależności od tego, czy usuwasz token dostępu lub 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 zasad jest definiowany przez schemat XML (.xsd). Schematy zasad są dostępne na GitHubie.

Powiązane artykuły