刪除 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。

這項設定僅供內部最佳化使用。

 false 選用
continueOnError

多數政策預期會在失敗時傳回錯誤。透過設定 屬性設為 true，則資料流執行作業會在失敗時繼續進行。

 false 選用
已啟用 決定是否強制執行政策。如果設為 false，系統會傳送 政策「已停用」且不會強制執行 (即使該政策依附於 Flow)。 true 選用
名稱

政策的內部名稱。要在 Step 元素中參照這個名稱 再將政策套用至流程

注意：名稱中可用的字元僅限於： A-Z0-9._\-$ %。管理 UI 會強制執行額外的限制，例如 自動移除非英數字元。

 不適用 必填

&lt;AccessToken&gt;元素

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設： 不適用
所在地： <AccessToken> 或 <AuthorizationCode> 為 這通常代表交易 不會十分要求關聯語意
類型： 字串

屬性

屬性 說明 預設 存在必要性
參考資料

存取權杖變數。通常擷取自流程變數。適用對象 例如 request.header.token 或 request.queryparam.token。

 不適用 選用

&lt;AuthorizationCode&gt;元素

識別要刪除的授權代碼所在的變數。舉例來說， 授權碼會附加在要求訊息中，做為「code」查詢參數。請指定 request.queryparam.code。您可以使用參照該權杖的任何有效變數。 或者，也可以傳入常值權杖字串 (極少有大小寫之分)。

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設： 不適用
所在地： <AccessToken> 或 <AuthorizationCode> 為 這通常代表交易 不會十分要求關聯語意
類型： 字串

屬性

屬性 說明 預設 存在必要性
參考資料

存取權杖變數。通常擷取自流程變數。適用對象 例如 request.header.code 或 request.queryparam.code。

 不適用 選用

&lt;DisplayName&gt; 元素

管理 UI Proxy 編輯器中政策的自然語言名稱。省略時 政策名稱屬性

<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 提供許多資源。

相關主題