DeleteOAuthV2Info

Вы просматриваете документацию по 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.

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

 false Необязательно
continueOnError

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

 false Необязательно
включено Определяет, применяется ли правило. Если задано значение false, правило "отключается" и не применяется (даже если оно по-прежнему связано с потоком). true Необязательно
name

Внутреннее название правила. Это название используется в элементах шага, чтобы прикрепить правило к потоку.

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

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

Элемент <AccessToken>

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

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

Атрибуты

Атрибут Описание По умолчанию Тип поля
ref

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

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

Элемент <AuthorizationCode>

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

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

Атрибуты

Атрибут Описание По умолчанию Тип поля
ref

Переменная токена доступа. Обычно извлекается из переменной потока. Примеры: 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.

Статьи по теме