GetOAuthV1Info ポリシー

概要

トークンとキーの属性を取得し、これらの属性値をフロー変数に設定します。このポリシータイプは、構成トークンやキーの値に基づいて条件付きの動的動作を構成する場合に便利な場合があります。トークンが検証されるたびに、トークン属性の値が自動的に変数へ設定されます。ただしトークン検証が行われていない場合は、この機能を使って変数にこれらの属性値を明示的に設定できます。OAuth v1.0a ポリシーもご覧ください。

要素リファレンス

要素リファレンスでは、GetOAuthV1Info ポリシーの要素と属性について説明します。

    <GetOAuthV1Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v10a-Info-1">
        <DisplayName>Get OAuth v1.0a Info-1</DisplayName>
        <ConsumerKey ref="{flow.variable}">{value}</ConsumerKey>
        <RequestToken ref="{flow.variable}">{request token}</RequestToken>
        <AccessToken ref="{flow.variable}">{access token}</AccessToken>
        <OAuthConfig ref="{flow.variable}">{config}</OAuthConfig>
    </GetOAuthV1Info>
    

<GetOAuthV1Info> の属性

    <GetOAuthV1Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v10a-Info-1">
    

次の表に、ポリシーのすべての親要素に共通の属性を記載します。

属性 説明 デフォルト 要否
name

ポリシーの内部名。name 属性の値には、文字、数字、スペース、ハイフン、アンダースコア、ピリオドを使用できます。255 文字を超える値を指定することはできません。

必要に応じて、管理 UI プロキシ エディタで <DisplayName> 要素を使用してポリシーに別のわかりやすい名前でラベルを付けます。

なし 必須
continueOnError

ポリシーが失敗した場合にエラーを返すには、false に設定します。これはほとんどのポリシーで想定される動作です。

ポリシーが失敗してもフロー実行を続行するには、true に設定します。

false 省略可
enabled

ポリシーを適用するには true に設定します。

ポリシーを無効にするには false に設定します。その場合、ポリシーはフローに接続されていているとしても適用されません。

true 省略可
async

この属性は非推奨となりました。

false 非推奨

<DisplayName> 要素

name 属性に加えて、管理 UI プロキシ エディタのポリシーに別のわかりやすい名前でラベルを付けるために使います。

<DisplayName>Policy Display Name</DisplayName>
デフォルト:

なし

この要素を省略した場合、ポリシーの name 属性の値が使用されます

要否: 省略可
型: 文字列

<AccessToken> 要素

アクセス トークンを検証して、すべての属性を取得します。リソースはフローの変数 flow.resource.name で設定する必要があります。成功すると、属性はフロー変数として使用できます。アクセス トークン文字列またはリテラルのトークン文字列(まれなケース)のどちらかが入った変数を渡します。次の例では、アクセス トークンはリクエストで渡されたクエリ パラメータから取得されます。

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

デフォルト:

request.formparam.access_tokenx-www-form-urlencoded、リクエスト本文で指定)

要否:

省略可

型: 文字列
有効な値:

アクセス トークン文字列が入ったフロー変数、またはリテラル文字列のどちらか。

<ConsumerKey> 要素

プロファイルのコンシューマ キーを取得します。アクセス トークン文字列またはリテラルのトークン文字列(まれなケース)のどちらかが入った変数を渡します。次の例では、アクセス トークンはリクエストで渡されたクエリ パラメータから取得されます。

    <ConsumerKey ref="request.queryparam.consumer_key"></ConsumerKey>
    

デフォルト:

request.formparam.consumer_keyx-www-form-urlencoded、リクエスト本文で指定)

要否:

省略可

型: 文字列
有効な値:

アクセス トークン文字列が入ったフロー変数、またはリテラル文字列のどちらか。

<OAuthConfig> 要素

OAuth 構成情報を検証します。

    <OAuthConfig ref="request.queryparam.oauth_config"></OAuthConfig>
    

デフォルト:

request.formparam.access_tokenx-www-form-urlencoded、リクエスト本文で指定)

要否:

省略可

型: 文字列
有効な値:

アクセス トークン文字列が入ったフロー変数、またはリテラル文字列のどちらか。

<RequestToken> 要素

プロファイルのリクエスト トークンを取得します。アクセス トークン文字列またはリテラルのトークン文字列(まれなケース)のどちらかが入った変数を渡します。次の例では、アクセス トークンはリクエストで渡されたクエリ パラメータから取得されます。

    <RequestToken ref="request.queryparam.request_token"></RequestToken>
    

デフォルト:

request.formparam.request_tokenx-www-form-urlencoded、リクエスト本文で指定)

要否:

省略可

型: 文字列
有効な値:

アクセス トークン文字列が入ったフロー変数、またはリテラル文字列のどちらか。

フロー変数

GetOAuthV1Info ポリシーはこれらの変数に値を設定し、通常は、認可または検証がまだ行われていないが、プロファイル データが必要な場合に使用されます。

コンシューマ キー変数

以下の変数は、<ConsumerKey> オペレーションが実行されると、値が設定されます。

    oauthconsumer.{policy_name}.oauth_consumer_key
    oauthconsumer.{policy_name}.oauth_consumer_key
    oauthconsumer.{policy_name}.{app_attribute_name}
    oauthconsumer.{policy_name}.{app_key_attribute_name}
    

アクセス トークンおよびリクエスト トークンの変数

以下の変数は、<AccessToken> または <RequestToken> のオペレーションが実行されると、値が設定されます。

    oauth_token
    oauth_token_secret
    
    developer.app.name
    developer.id
    
    apiproduct.name
    apiproduct.<custom_attribute_name>
    

ポリシー固有のエラーコード

OAuth HTTP エラー レスポンス リファレンスをご覧ください。

スキーマ

ポリシータイプは XML スキーマ(.xsd)で定義されます。GitHub に参照用のポリシー スキーマが用意されています。

エラーコード

Get OAuth v1.0a Info ポリシーに指定されたエラーコードはありません。

関連トピック