SetOAuthV2Info 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

結果

可讓您新增或更新與存取權杖相關聯的自訂屬性。自訂屬性 可能包括部門名稱、客戶 ID 或工作階段 ID其他參考資訊 自訂權杖和 授權碼。

而只能新增或修改自訂屬性。您無法依據這項政策變更以下欄位： 範圍、status、expiration_in、developer_email、client_id、org_name 或 refresh_count。如果 屬性已存在，這項政策會更新該屬性。如果該政策不存在，這項政策會新增該物件。 參照的存取權杖必須是有效且處於已核准的狀態。

範例

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

元素參照

元素參照會說明 SetOAuthV2 政策的元素和屬性。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

<SetOAuthV2Info>屬性

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

下表說明所有政策父項元素的共同屬性：

&lt;DisplayName&gt;元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt;元素

識別存取權杖所在的變數。舉例來說，如果存取權杖是 做為查詢參數附加在要求訊息中 request.queryparam.access_token。您可以使用任何參照 產生下一個符記或者，也可以傳入常值權杖字串 (極少有大小寫之分)。

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

屬性

&lt;Attributes&gt;元素

存取權杖設定檔中的一組屬性，會修改或擴充。

&lt;Attributes&gt;/&lt;Attribute&gt;元素

要更新的個別屬性。

名稱屬性可識別要存取權杖設定檔的自訂屬性 已更新。本例說明如何使用參照的變數值和靜態值。

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

屬性

流程變數

成功後，將設定下列流程變數：

• oauthv2accesstoken.{policyName}.access_token
• oauthv2accesstoken.{policyName}.client_id
• oauthv2accesstoken.{policyName}.refresh_count
• oauthv2accesstoken.{policyName}.organization_name
• oauthv2accesstoken.{policyName}.expires_in //--in seconds
• oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
• oauthv2accesstoken.{policyName}.issued_at
• oauthv2accesstoken.{policyName}.status
• oauthv2accesstoken.{policyName}.api_product_list
• oauthv2accesstoken.{policyName}.token_type
• oauthv2accesstoken.{policyName}.{custom_attribute_name}

結構定義

每種政策類型都是由 XML 架構 (.xsd) 定義。供參考政策結構定義 GitHub 提供許多資源。

錯誤參考資料

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

相關主題

• OAuthV2 政策
• OAuth 首頁
• 自訂權杖 和授權碼