刪除 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">
屬性 說明 預設 存在必要性
async

設為 true，即可指定政策應在由要求/回應流程提供服務的執行緒集區中執行。預設值為 false。

這項設定只會用於內部最佳化。

 false 選用
continueOnError

如果發生錯誤，多數政策都會傳回錯誤。將此屬性設為 true 後，流程會在失敗時繼續執行。

 false 選用
已啟用 決定是否要強制執行政策。如果設為 false，政策會「停用」，且不會強制執行 (即使政策仍連結至資料流)。 true 選用
名稱

政策的內部名稱。系統會在步驟元素中參照這個名稱，以便將政策連結至資料流。

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

 不適用 必要

<AccessToken> 元素

識別要刪除的存取權杖所在的變數。舉例來說，如果存取權杖是以名為「access_token」的查詢參數附加至要求訊息，請指定 request.queryparam.access_token。您可以使用任何參照權杖的有效變數。或者，也可以傳入常值權杖字串 (罕見大小寫)。

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設： 不適用
所在地： 必須使用 <AccessToken> 或 <AuthorizationCode>。
類型： 字串

屬性

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

存取權杖變數。一般而言，擷取自流程變數。例如 request.header.token 或 request.queryparam.token。

 不適用 選用

<AuthorizationCode> 元素

識別要刪除的授權碼所在位置的變數。舉例來說，如果驗證碼是以名為「code」的查詢參數附加至要求訊息，請指定 request.queryparam.code。您可以使用任何參照權杖的有效變數。或者，也可以傳入常值權杖字串 (罕見大小寫)。

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設： 不適用
所在地： 必須使用 <AccessToken> 或 <AuthorizationCode>。
類型： 字串

屬性

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

存取權杖變數。一般而言，擷取自流程變數。例如 request.header.code 或 request.queryparam.code。

 不適用 選用

<DisplayName> 元素

這個自然語言名稱可在管理 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 提供政策結構定義。

相關主題