УдалитьOAuthV2Info

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

О нас | Образцы | Ссылка на элемент | Выход | Схема | Связанные темы

Что

Удаляет указанный код авторизации OAuth V2 или токен доступа.

Образцы

Удалить токен доступа

Ниже приведен пример политики, используемой для удаления токена доступа OAuth 2.0. В приведенном ниже примере маркер доступа для удаления находится в сообщении запроса путем поиска заголовка с именем access_token .

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

Ниже приведен пример политики, используемой для удаления кода авторизации OAuth 2.0. В приведенном ниже примере код аутентификации, который нужно удалить, находится в сообщении запроса путем поиска параметра запроса с именем code .

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

Ссылка на элемент

Ссылка на элемент описывает элементы и атрибуты политики 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> 

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Атрибут Описание По умолчанию Присутствие
асинхронный

Установите значение true , чтобы указать, что политика должна выполняться в пуле потоков, отличном от пула, обслуживающего поток запросов/ответов. По умолчанию — false .

Этот параметр используется только для внутренней оптимизации.

 ЛОЖЬ Необязательный
продолжитьOnError

Ожидается, что большинство политик вернут ошибку при возникновении сбоя. Если для этого атрибута установлено true , выполнение потока продолжится в случае сбоя.

 ЛОЖЬ Необязательный
включено Определяет, применяется ли политика или нет. Если установлено значение false , политика «отключается» и не применяется (даже если политика остается прикрепленной к потоку). истинный Необязательный
имя

Внутреннее имя политики. Это имя используется в элементах Step для присоединения политики к потоку.

Примечание. В имени можно использовать следующие символы: A-Z0-9._\-$ % . Пользовательский интерфейс управления налагает дополнительные ограничения, например автоматическое удаление символов, не являющихся буквенно-цифровыми.

 Н/Д Необходимый

Элемент <AccessToken>

Идентифицирует переменную, в которой находится удаляемый токен доступа. Например, если токен доступа прикреплен к сообщению запроса в качестве параметра запроса с именем «access_token», укажите request.queryparam.access_token . Вы можете использовать любую допустимую переменную, ссылающуюся на токен. Или можно передать буквальную строку токена (редкий случай).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
По умолчанию: Н/Д
Присутствие: Требуется либо <AccessToken> , либо <AuthorizationCode> .
Тип: Нить

Атрибуты

Атрибут Описание По умолчанию Присутствие
ссылка

Переменная токена доступа. Обычно извлекается из переменной потока. Например: request.header.token или request.queryparam.token .

 Н/Д Необязательный

Элемент <AuthorizationCode>

Идентифицирует переменную, в которой находится код авторизации, который нужно удалить. Например, если код аутентификации прикреплен к сообщению запроса в качестве параметра запроса с именем «код», укажите request.queryparam.code . Вы можете использовать любую допустимую переменную, ссылающуюся на токен. Или можно передать буквальную строку токена (редкий случай).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
По умолчанию: Н/Д
Присутствие: Требуется либо <AccessToken> , либо <AuthorizationCode> .
Тип: Нить

Атрибуты

Атрибут Описание По умолчанию Присутствие
ссылка

Переменная токена доступа. Обычно извлекается из переменной потока. Например: request.header.code или request.queryparam.code .

 Н/Д Необязательный

Элемент <DisplayName>

Имя на естественном языке, которое обозначает политику в редакторе прокси-сервера пользовательского интерфейса управления. Если этот параметр опущен, используется атрибут имени политики.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
По умолчанию: Значение атрибута name политики.
Присутствие: Необязательный
Тип: Нить

Выход

В случае успеха политика возвращает статус 200.

В случае сбоя политика возвращает 404 и выводит примерно следующий результат (в зависимости от того, удаляете ли вы токен доступа или код аутентификации):

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

Схема

Каждый тип политики определяется схемой XML ( .xsd ). Для справки: схемы политик доступны на GitHub.

Связанные темы