OAuth Module リファレンス - Mule 4

オブジェクトストア

OAuth コンテキストデータを保存するオブジェクトストア。

String (文字列)

localCallbackUrl​ の代わりに使用するリスナー設定。この設定を使用する場合、​localCallbackConfigPath​ も個別に指定する必要があります。

String (文字列)

localCallbackConfig​ に応じて作成されたリスナーのローカルパス。​localCallbackUrl​ を使用する場合は必要ありません。

String (文字列)

手動で認証コードを抽出するためのエンドポイントがすでに登録されている場合を除き、認証コードを保存する設定済みの URL のエンドポイントを Mule Runtime Engine (Mule) で自動的に作成できるようにする URL。

String (文字列)

OAuth 認証サーバーはこの URL を使用して、アクセストークンを取得するための認証コードを Mule サーバーに提供します。この URL は、ローカルアドレスではなく、外部に表示できるコールバックアドレスである必要があります。

x

String (文字列)

redirectUrl​ に対して OAuth 認証サーバーから実行される認証要求とコールバック間の状態を保持する状態パラメーター。

String (文字列)

OAuth 認証属性 (accessToken や refreshToken など) を保存する識別子。この属性は、アプリケーションが OAuth 認証サーバーの複数のユーザーのリソースにアクセスするときにのみ必要になります。

String (文字列)

ユーザーが各自のアカウントに対してアプリケーションへのアクセスを認証して許可するためのホストサーバーのエンドポイントを Mule で自動的に作成できるようにする URL。

x

String (文字列)

特定のユーザーに対してアプリケーションを認証する OAuth 認証サーバー URL。

x

Object (オブジェクト)

認証要求 URL または OAuth 認証サーバーに送信するカスタムパラメーター。

String (文字列)

OAuth 認証属性 (accessToken や refreshToken など) を保存する識別子。この属性は、アプリケーションが OAuth 認証サーバーの複数のユーザーのリソースにアクセスするときにのみ必要になります。

default

Boolean (ブール)

true​ の場合、クライアント ID とクライアントシークレットがリクエストボディで送信されます。それ以外の場合、クライアント ID とクライアントシークレットが基本認証として送信されます。

true

String (文字列)

OAuth 認証サーバーで定義されるアプリケーション識別子。

x

String (文字列)

OAuth 認証サーバーで定義されるアプリケーションシークレット。

x

String (文字列)

実行するアプリケーションによって求められるスコープ。スコープでは、リソースに対する権限を定義します。

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

許可種別で使用するトークンマネージャー設定。

String (文字列)

トークンにアクセスするための OAuth 認証サーバー URL。Mule は、​redirectUrl​ を介して OAuth サーバーから認証コードを取得した後に、この URL をコールしてアクセストークンを取得します。

x

String (文字列)

tokenUrl​ へのコールへの応答からアクセストークンパラメーターを抽出する式。

#[payload.access_token]

String (文字列)

応答更新トークン。

#[payload.refresh_token]

String (文字列)

tokenUrl​ へのコールへの応答からパラメーターの有効期限を抽出する式。

#[payload.expires_in]

Parameter Extractor (パラメーターエクストラクター)​ の配列

Boolean (ブール)

式で API コールバックの HTTP 応答に対して評価し、期限切れのトークンを使用して実行されたことが原因で要求が失敗したかどうかを判断できるようにします。評価で ​true​ (アクセストークンが期限切れ) が返されると、Mule は自動的に更新トークンフローをトリガーし、新しいアクセストークンを使用して API コールバックを再試行します。デフォルト値では、応答状況コードが ​401​ なのか、​403​ なのかを評価します。

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

TLS

受信 HTTP 要求を受信し、OAuth ダンス中に HTTP 要求を実行するための TLS 設定。

String (文字列)

パラメーターエクストラクター名。

x

String (文字列)

この型の値。

x

String (文字列)

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

String (文字列)

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

Truststore (トラストストア)

TLS トラストストアを設定します。

Keystore (キーストア)

TLS キーストアを設定します。

取り消し確認設定。

String (文字列)

トラストストアへのパス。Mule では、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

String (文字列)

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

String (文字列)

ストアの型。

String (文字列)

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

Boolean (ブール)

true​ の場合、Mule では証明書の検証の実行を停止します。この属性を ​true​ に設定すると、接続が攻撃に対して脆弱になります。

String (文字列)

キーストアへのパス。Mule では、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

String (文字列)

ストアの型。

String (文字列)

キーストアに複数の非公開キーが含まれている場合に使用するキーの別名。デフォルトでは、Mule はファイル内の最初のキーを使用します。

String (文字列)

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

String (文字列)

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

String (文字列)

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

Boolean (ブール)

証明書チェーン内で確認する要素:

Boolean (ブール)

証明書の有効性を確認する方法:

オンライン証明書状況プロトコル (OCSP) で証明書の有効性を確認します。

Boolean (ブール)

証明書の有効性を確認するための第 2 の方法を使用するかどうか:

[Prefer Crls (CRL を優先)]​ 項目で指定されていない方法を使用して証明書の有効性を確認します。

[Prefer Crls (CRL を優先)]​ 項目で指定されている方法を使用しないで証明書の有効性を確認します。

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合の処理:

検証エラーを回避します。

検証の失敗を許可します。

String (文字列)

OCSP レスポンダーの URL。

String (文字列)

OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアで設定される必要があります。

String (文字列)

CRL ファイルへのパス。

Boolean (ブール)

true の場合、クライアント ID とクライアントシークレットがリクエストボディで送信されます。それ以外の場合、クライアント ID とクライアントシークレットが基本認証として送信されます。

false

String (文字列)

OAuth 認証サーバーで定義されるアプリケーション識別子。

x

String (文字列)

OAuth 認証サーバーで定義されるアプリケーションシークレット。

x

String (文字列)

実行するアプリケーションによって求められるスコープ。スコープでは、リソースに対する権限を定義します。

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

許可種別で使用するトークンマネージャー設定。

String (文字列)

トークンにアクセスするための OAuth 認証サーバー URL。Mule は、​redirectUrl​ を介して OAuth サーバーから認証コードを取得した後に、この URL をコールしてアクセストークンを取得します。

x

String (文字列)

tokenUrl​ へのコールへの応答からアクセストークンパラメーターを抽出する式。

#[payload.access_token]

String (文字列)

応答更新トークン。

#[payload.refresh_token]

String (文字列)

tokenUrl​ へのコールへの応答からパラメーターの有効期限を抽出する式。

#[payload.expires_in]

Parameter Extractor (パラメーターエクストラクター)​ の配列

カスタムパラメーターエクストラクターの設定。

Boolean (ブール)

式で API コールバックの HTTP 応答に対して評価し、期限切れのトークンを使用して実行されたことが原因で要求が失敗したかどうかを判断できるようにします。評価で ​true​ (アクセストークンが期限切れ) が返されると、Mule は自動的に更新トークンフローをトリガーし、新しいアクセストークンを使用して API コールバックを再試行します。デフォルト値では、応答状況コードが ​401​ なのか、​403​ なのかを評価します。

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

TLS

受信 HTTP 要求を受信し、OAuth ダンス中に HTTP 要求を実行するための TLS 設定。