DeleteOAuthV2Info

概要

指定された 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	省略可
enabled	ポリシーを適用するかどうかを設定します。`false` に設定すると、ポリシーは「オフ」になり、適用されません（ポリシーはフローに接続されたままになります）。	true	省略可
name	ポリシーの内部名。この名前は、ポリシーをフローに接続するときに Step 要素で参照されます。注: 名前に使用できる文字は、`A-Z0-9._\-$ %` のみです。管理 UI では、この他にも制限があります。たとえば、英数字以外の文字は自動的に削除されます。	なし	必須

<AccessToken> 要素

削除するアクセストークンが格納されている変数を指定します。たとえば、アクセストークンが「access_token」というクエリパラメータとしてリクエストメッセージに添付されている場合は、request.queryparam.access_token を指定します。トークンを参照する有効な変数を使用できます。まれなケースですが、リテラルトークン文字列を渡すこともできます。

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

デフォルト:	なし
要否:	`<AccessToken>` または `<AuthorizationCode>` が必須です。
型:	String

属性

属性	説明	デフォルト	要否
ref	アクセストークン変数。通常、フロー変数から取得します。たとえば、`request.header.token` や `request.queryparam.token` などです。	なし	省略可

<AuthorizationCode> 要素

削除する認証コードが格納されている変数を指定します。たとえば、認証コードが「code」というクエリパラメータとしてリクエストメッセージに添付されている場合は、request.queryparam.code を指定します。トークンを参照する有効な変数を使用できます。まれなケースですが、リテラルトークン文字列を渡すこともできます。

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

デフォルト:	なし
要否:	`<AccessToken>` または `<AuthorizationCode>` が必須です。
型:	String

属性

属性	説明	デフォルト	要否
ref	アクセストークン変数。通常、フロー変数から取得します。たとえば、`request.header.code` や `request.queryparam.code` などです。	なし	省略可

<DisplayName> 要素

管理 UI のプロキシエディタでポリシーに設定する自然言語のラベル名です。省略すると、ポリシー名の name 属性が使用されます。

<DisplayName>DeleteOAuthV2Info 1</DisplayName>

デフォルト:	ポリシーの `name` 属性の値。
要否:	省略可
型:	String

出力

成功すると、ポリシーは 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 から入手できます。