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">
属性 说明 默认 状态
async

设置为 true 以指定政策应在与请求/响应流运行的池不同的线程池中运行。默认值为 false。

此设置仅用于内部优化。

 false 选填
continueOnError

大多数政策会在发生故障时返回错误。将此属性设置为 true 后，流执行会失败。

 false 选填
已启用 确定是否强制执行政策。如果设置为 false，则政策会“关闭”，并且不会强制执行（即使政策仍附加到某个流）。 true 可选
name

政策的内部名称。此名称在 Step 元素中引用，以便将政策附加到流。

注意：您可以在名称中使用的字符仅限于：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> 元素

标识要删除的授权代码所在的变量。例如，如果 auth 代码作为查询参数（名为“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 提供了政策架构作为参考。

相关主题