GetOAuthV2Info 政策

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

内容

获取访问令牌属性、刷新令牌、授权代码和客户端应用属性，并使用这些属性的值填充变量。

当您需要根据令牌或身份验证代码中的值配置动态条件行为时，此政策很有用。每当发生令牌验证时，都会使用填充令牌属性的值自动填充变量。但是，如果未发生令牌验证，您可以使用此功能用令牌的属性值明确填充变量。另请参阅自定义令牌和授权代码。

您传递给此政策的访问令牌必须有效，否则政策将抛出 invalid_access_token 错误。

示例

以下示例使用“获取 OAuth V2 信息”政策检索有关 OAuth2 工作流的各个组件的信息，然后在代码中访问该信息。

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

元素参考

元素参考介绍了 GetOAuthV2Info 政策的元素和属性。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

<GetOAuthV2Info> 属性

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

下表介绍了所有政策父元素通用的特性：

<DisplayName> 元素

除了用于 name 属性之外，还可以用于在管理界面代理编辑器中给政策添加不同的自然语言名称标签。

<DisplayName>Policy Display Name</DisplayName>

<AccessToken> 元素

检索访问令牌的配置文件。您可以传入一个包含访问令牌字符串或字面量令牌字符串的变量（罕见情况下）。在此示例中，从请求中传递的查询参数中检索访问令牌。如果要返回已撤销令牌或过期令牌的信息，请使用<IgnoreAccessTokenStatus>元素。

<AccessToken ref="request.queryparam.access_token"></AccessToken>

<AuthorizationCode> 元素

检索授权代码的配置文件。您可以传入包含 Auth 代码字符串或字面量令牌字符串（罕见情况）的变量。在此示例中，系统将从请求中传递的查询参数中检索 Auth 代码。如需查看此操作所填充的变量列表，请参阅“流变量”。

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

<ClientId> 元素

检索与客户端 ID 相关的信息。在此示例中，从请求中传递的查询参数中检索客户端 ID。如需查看此操作所填充的变量列表，请参阅“流变量”。

<ClientId ref="request.queryparam.client_id"></ClientId>

<IgnoreAccessTokenStatus> 元素

即使令牌已过期或被撤消，也会返回令牌信息。此元素只能与访问令牌一起使用。默认情况下，无论其他实体（例如刷新令牌和授权代码）的状态如何，系统都会返回其信息。

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

<RefreshToken> 元素

检索刷新令牌的配置文件。您传入一个包含刷新令牌字符串或字面量令牌字符串（罕见情况）的变量。在此示例中，从请求中传递的查询参数中检索刷新令牌。如需查看此操作所填充的变量列表，请参阅“流变量”。

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

流变量

GetOAuthV2Info 政策可用于填充这些变量，并且通常在需要配置文件数据，但尚未对其进行授权或验证的情况下使用。.

客户端 ID 变量

设置 ClientId 元素时，将填充这些变量：

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

访问令牌变量

设置 AccessToken 元素时，将填充这些变量：

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

授权代码变量

设置 AuthorizationCode 元素时，将填充这些变量：

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

刷新令牌变量

设置 RefreshToken 元素时，将填充这些变量：

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

架构

每种政策类型均由 XML 架构 (.xsd) 定义。GitHub 提供了政策架构作为参考。

错误参考信息

本部分介绍了在此政策触发错误时返回的错误代码和错误消息，以及 Edge 设置的故障变量。 在开发故障规则以处理故障时，请务必了解此信息。如需了解详情，请参阅您需要了解的有关政策错误的信息和处理故障。

运行时错误

政策执行时可能会发生这些错误。 下面显示的错误名称是在发生错误时分配给 fault.name 变量的字符串。如需了解详情，请参阅下面的故障变量部分。

部署错误

如需了解部署错误，请参阅界面中报告的消息。

故障变量

当此政策在运行时触发错误时，将设置这些变量。

错误响应示例

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

故障规则示例

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

相关主题

• OAuthV2 政策
• OAuth 首页
• 自定义令牌和授权代码