刪除 OAuthV2Info

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

簡介 | 範例 | 元素參考資料 | 輸出內容 | 結構定義 | 相關主題

結果

刪除指定的 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 選用
名稱

政策的內部名稱。這個名稱會在「步驟」元素中參照，將政策附加至流程。

注意：名稱只能使用以下字元： A-Z0-9._\-$ %。管理 UI 會強制執行額外限制，例如自動移除非英數字元。

 N/A 必填

<AccessToken> 元素

找出要刪除存取權杖的變數。舉例來說，如果存取權杖以名為「access_token」的查詢參數形式附加至要求訊息，請指定 request.queryparam.access_token。您可以使用任何參照權杖的有效變數。或者，也可以傳入字面值權杖字串 (極少數情況)。

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設值： N/A
外觀狀態： 您必須使用 <AccessToken> 或 <AuthorizationCode> 其中之一。
類型： 字串

屬性

屬性 說明 預設 存在必要性
ref

存取權杖變數。通常是從流程變數擷取。例如：request.header.token 或 request.queryparam.token。

 N/A 選用

<AuthorizationCode> 元素

找出要刪除授權碼的變數。舉例來說，如果授權碼以名為「code」的查詢參數形式附加至要求訊息，請指定 request.queryparam.code。您可以使用任何參照權杖的有效變數。 或者，也可以傳入字面值權杖字串 (極少數情況)。

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
預設值： N/A
外觀狀態： 您必須使用 <AccessToken> 或 <AuthorizationCode> 其中之一。
類型： 字串

屬性

屬性 說明 預設 存在必要性
ref

存取權杖變數。通常是從流程變數擷取。例如：request.header.code 或 request.queryparam.code。

 N/A 選用

<DisplayName> 元素

自然語言名稱，用於在管理 UI 代理編輯器中標記政策。如果省略這項屬性，系統會使用政策名稱屬性。

<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 查看政策架構。

相關主題