--- schema_version: "1" id: 828873a6a583955ca4af8720a0f8d767c18cadf6d222b7d823931d171ca85a4b title: OAuth Module リファレンス collection: mulesoft version: current locale: ja-jp portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/oauth-module/latest/oauth-module-reference.md canonical_url: https://docs.mulesoft.com/jp/oauth-module/latest/oauth-module-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 0c929cb9c25d540adf79b13fbeb2e08fb8c6013c5075ceb522ada8a86550f5fa description: MuleSoft Documentation Site release: "1.1" latest: true --- # OAuth Module リファレンス OAuth Module v1.1 OAuth Module は、OAuth2 を HTTP 拡張コネクタに接続するための拡張機能です。 ## [](#設定)設定 * * * ### [](#config)設定 デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x
## [](#操作)操作 - [Invalidate Oauth Context](#invalidateOauthContext) - [Retrieve Access Token](#retrieveAccessToken) - [Retrieve Custom Token Response Param](#retrieveCustomTokenResponseParam) - [Retrieve Expires In](#retrieveExpiresIn) - [Retrieve Refresh Token](#retrieveRefreshToken) - [Retrieve State](#retrieveState) ### [](#invalidateOauthContext)Invalidate Oauth Context `` トークンマネージャーとリソースオーナー ID の OAuth コンテキストをクリアします。 #### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default
### [](#retrieveAccessToken)Retrieve Access Token `` パラメーター化されたリソースオーナー ID に対するトークンマネージャーのアクセストークンを返します。 #### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]
#### [](#出力)出力

型

String (文字列)
### [](#retrieveCustomTokenResponseParam)Retrieve Custom Token Response Param `` パラメーター化されたリソースオーナー ID に対するトークンマネージャーからの OAuth ダンス中に抽出されたパラメーターの値を返します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default

Key (キー)

String (文字列)

OAuth ダンスの後に抽出された要素を検索するためのキー。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]
#### [](#出力-2)出力

型

String (文字列)
### [](#retrieveExpiresIn)Retrieve Expires In `` パラメーター化されたリソースオーナー ID の OAuth コンテキストの有効期限を返します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]
#### [](#出力-3)出力

型

String (文字列)
### [](#retrieveRefreshToken)Retrieve Refresh Token `` パラメーター化されたリソースオーナー ID の OAuth コンテキストの更新トークンを返します。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]
#### [](#出力-4)出力

型

String (文字列)
### [](#retrieveState)Retrieve State `` パラメーター化されたリソースオーナー ID の OAuth コンテキストの状態を返します。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

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

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

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

x

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

String (文字列)

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

default

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]
#### [](#出力-5)出力

型

String (文字列)
## [](#型)型 ### [](#token-manager-config)Token Manager Config (トークンマネージャー設定)
項目 型 説明 デフォルト値 必須

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

オブジェクトストア

OAuth コンテキストデータを保存するオブジェクトストア。
### [](#authorization-code-grant-type)Authorization Code Grant Type (認証コード許可種別)
項目 型 説明 デフォルト値 必須

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

String (文字列)

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

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

String (文字列)

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

ローカルコールバック URL

String (文字列)

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

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

String (文字列)

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

x

State (状態)

String (文字列)

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

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

String (文字列)

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

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

String (文字列)

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

x

Authorization Url (認証 URL)

String (文字列)

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

x

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

Object (オブジェクト)

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

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

String (文字列)

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

default

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

Boolean (ブール)

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

true

Client Id (クライアント ID)

String (文字列)

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

x

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

String (文字列)

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

x

Scopes (スコープ)

String (文字列)

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

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

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

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

Token Url (トークン URL)

String (文字列)

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

x

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

String (文字列)

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

#[payload.access_token]

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

String (文字列)

応答更新トークン。

#[payload.refresh_token]

Response Expires In (応答有効期限)

String (文字列)

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

#[payload.expires_in]

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

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

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

Boolean (ブール)

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

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

Tls Context (TLS コンテキスト)

TLS

受信 HTTP 要求を受信し、OAuth ダンス中に HTTP 要求を実行するための TLS 設定。
### [](#ParameterExtractor)Parameter Extractor (パラメーターエクストラクター)
項目 型 説明 デフォルト値 必須

Param Name (パラメーター名)

String (文字列)

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

x

Value (値)

String (文字列)

この型の値。

x
### [](#Tls)TLS Mule アプリケーションのセキュアな通信を提供するように TLS を設定します。
項目 型 説明 デフォルト値 必須

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

String (文字列)

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

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

String (文字列)

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

Trust Store (トラストストア)

Truststore (トラストストア)

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

Key Store (キーストア)

Keystore (キーストア)

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

Revocation Check (取り消し確認)

取り消し確認設定。
### [](#TrustStore)Truststore (トラストストア) TLS 用のトラストストアを設定します。
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

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

Password (パスワード)

String (文字列)

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

Type (型)

String (文字列)

ストアの型。

Algorithm (アルゴリズム)

String (文字列)

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

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、Mule では証明書の検証の実行を停止します。この属性を ​true​ に設定すると、接続が攻撃に対して脆弱になります。
### [](#KeyStore)Keystore (キーストア) TLS プロトコル用のキーストアを設定します。生成したキーストアには、非公開キーと公開証明書が格納されます。
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

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

Type (型)

String (文字列)

ストアの型。

Alias (別名)

String (文字列)

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

Key Password (キーパスワード)

String (文字列)

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

Password (パスワード)

String (文字列)

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

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用する暗号化アルゴリズム。
### [](#standard-revocation-check)Standard Revocation Check (標準の取り消し確認) TLS 証明書の標準取り消し確認を設定します。
項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

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

  • true
    証明書チェーンの最後の要素のみを確認します。

  • false
    証明書チェーンのすべての要素を確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

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

  • true+ 証明書失効リスト (CRL) で証明書の有効性を確認します。

  • false+

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

No Fallback (代替なし)

Boolean (ブール)

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

  • true

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

  • false​

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

Soft Fail (ソフトフェール)

Boolean (ブール)

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

  • true​

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

  • false​

検証の失敗を許可します。
### [](#custom-ocsp-responder)Custom OCSP Responder (カスタム OCSP レスポンダー) 証明書の取り消し確認のカスタム OCSP レスポンダーを設定します。
項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアで設定される必要があります。
### [](#crl-file)CRL File (CRL ファイル) 証明書失効リスト (CRL) ファイルの場所を指定します。
項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。
### [](#ClientCredentialsGrantType)Client Credentials Grant Type (クライアントログイン情報許可種別)
項目 型 説明 デフォルト値 必須

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

Boolean (ブール)

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

false

Client Id (クライアント ID)

String (文字列)

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

x

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

String (文字列)

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

x

Scopes (スコープ)

String (文字列)

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

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

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

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

Token Url (トークン URL)

String (文字列)

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

x

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

String (文字列)

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

#[payload.access_token]

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

String (文字列)

応答更新トークン。

#[payload.refresh_token]

Response Expires In (応答有効期限)

String (文字列)

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

#[payload.expires_in]

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

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

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

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

Boolean (ブール)

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

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

TLS Context (TLS コンテキスト)

TLS

受信 HTTP 要求を受信し、OAuth ダンス中に HTTP 要求を実行するための TLS 設定。
## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com)