OAuth モジュールリファレンス - Mule 4

サポートカテゴリ: 選択

OAuth モジュール v1.1

OAuth2 を HTTP 拡張コネクタに接続するための拡張機能です。

リリースノート: ​OAuth モジュールリリースノート

POM ファイル情報

<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-oauth-module</artifactId>
  <version>RELEASE</version>
  <classifier>mule-plugin</classifier>
</dependency>

Mule は、RELEASE を現在のバージョンに変換します。バージョンを指定するには、Anypoint Exchange で OAuth プロバイダモジュール​を表示し、[Dependency Snippets (連動関係スニペット)]​ をクリックします。

設定


デフォルト設定

デフォルト設定

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x ​

操作

Invalidate OAuth Context

<oauth:invalidate-oauth-context>

トークンマネージャとリソースオーナー ID の OAuth コンテキストをクリアします。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

無効にするログイン情報を保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

無効にするリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

Retrieve Access Token

<oauth:retrieve-access-token>

パラメータ化されたリソースオーナー ID に対するトークンマネージャのアクセストークンを返します。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

アクセストークンを保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

取得するリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

 

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

 ​

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

 ​

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

 ​

出力

String (文字列)

Retrieve Custom Token Response Param

<oauth:retrieve-custom-token-response-param>

パラメータ化されたリソースオーナー ID に対するトークンマネージャからのダンス中に抽出されたパラメータの値を返します。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

アクセストークンを保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

取得するリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

Key (キー)

String (文字列)

前回の OAuth ダンス後に抽出された要素内で探すためのキー。

x ​

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

 ​

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

 ​

出力

Any (いずれか)

Retrieve Expires In

<oauth:retrieve-expires-in>

パラメータ化されたリソースオーナー ID の OAuth コンテキストの有効期限を返します。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

アクセストークンを保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

取得するリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

 

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

 ​

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

 ​

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

 ​

出力

String (文字列)

Retrieve Refresh Token

<oauth:retrieve-refresh-token>

パラメータ化されたリソースオーナー ID の OAuth コンテキストの更新トークンを返します。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

更新トークンを保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

取得するリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

 

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

 ​

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

 ​

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

 ​

出力

String (文字列)

Retrieve State

<oauth:retrieve-state>

パラメータ化されたリソースオーナー ID の OAuth コンテキストの状態を返します。

パラメータ

名前 説明 デフォルト値 必須

Token Manager (トークンマネージャ)

アクセストークンを保持するトークンマネージャ。

x ​

Resource Owner Id (リソースオーナー ID)

String (文字列)

取得するリソースオーナー ID。この属性は、許可種別が認証コードの場合のみ使用できます。

default

 ​

 

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

 ​

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

 ​

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

 ​

出力

String (文字列)

Token Manager Config (トークンマネージャ設定)

項目 説明 デフォルト値 必須

Object Store (オブジェクトストア)

Authorization Code Grant Type (認証コード許可種別)

項目 説明 デフォルト値 必須

Local Callback Config (ローカルコールバック設定)

String (文字列)

Local Callback Config Path (ローカルコールバック設定パス)

String (文字列)

ローカルコールバック URL

String (文字列)

External Callback Url (外部コールバック URL)

String (文字列)

x

State (状態)

String (文字列)

Local Authorization Url Resource Owner Id (ローカル認証 URL のリソースオーナー ID)

String (文字列)

Local Authorization Url (ローカル認証 URL)

String (文字列)

x

Authorization Url (認証 URL)

String (文字列)

x

Custom Parameters (カスタムパラメータ)

Object (オブジェクト)

Resource Owner Id (リソースオーナー ID)

String (文字列)

default

Client Id (クライアント ID)

String (文字列)

x

Client Secret (クライアントシークレット)

String (文字列)

x

スコープ

String (文字列)

Token Manager (トークンマネージャ)

Token Url (トークン URL)

String (文字列)

x

Response Access Token (応答アクセストークン)

String (文字列)

#[payload.access_token]

Response Refresh Token (応答更新トークン)

String (文字列)

#[payload.refresh_token]

Response Expires In (応答有効期限)

String (文字列)

#[payload.expires_in]

Custom Parameter Extractors (カスタムパラメータエクストラクタ)

Refresh Token When (更新トークン条件)

Boolean (ブール)

#[attributes.statusCode == 401 or attributes.statusCode == 403]

Tls Context Factory (TLS コンテキストファクトリ)

TLS

Parameter Extractor (パラメータエクストラクタ)

項目 説明 デフォルト値 必須

Param Name (パラメータ名)

String (文字列)

x

String (文字列)

x

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (信頼ストア)

Key Store (キーストア)

信頼ストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Client Credentials Grant Type (クライアントログイン情報許可種別)

項目 説明 デフォルト値 必須

Encode Client Credentials In Body (本文でのクライアントログイン情報のエンコード)

Boolean (ブール)

false

Client Id (クライアント ID)

String (文字列)

x

Client Secret (クライアントシークレット)

String (文字列)

x

スコープ

String (文字列)

Token Manager (トークンマネージャ)

Token Url (トークン URL)

String (文字列)

x

Response Access Token (応答アクセストークン)

String (文字列)

#[payload.access_token]

Response Refresh Token (応答更新トークン)

String (文字列)

#[payload.refresh_token]

Response Expires In (応答有効期限)

String (文字列)

#[payload.expires_in]

Custom Parameter Extractors (カスタムパラメータエクストラクタ)

Refresh Token When (更新トークン条件)

Boolean (ブール)

#[attributes.statusCode == 401 or attributes.statusCode == 403]

Tls Context Factory (TLS コンテキストファクトリ)

TLS

Was this article helpful?

💙 Thanks for your feedback!