ログイン情報挿入 OAuth 2.0 ポリシー
ポリシー名 |
ログイン情報挿入 OAuth 2.0 |
概要 |
発信要求に OAuth 2.0 認証ヘッダーを挿入する |
カテゴリ |
セキュリティ |
使用可能な最小 Flex Gateway バージョン |
v1.9.0 |
返される状況コード |
このポリシーの戻りコードは存在しません。アップストリームサービスからエラーコードが返されます。 |
概要
ログイン情報挿入 OAuth 2.0 ポリシーでは、OAuth 2.0 サービスから取得した Authorization トークンをヘッダーとして要求に挿入します。Okta、AWS、Azure、Google Cloud Platform などのサードパーティ OAuth 2.0 ID プロバイダー (IdP) を使用できます。このポリシーでは、Anypoint Platform に外部 IdP サーバーを登録しなくても、OAuth 2.0 認証フレームワークに基づくトークンを要求に挿入できます。
ポリシーのパラメーターの設定
Flex Gateway のローカルモード
ローカルモードでは、宣言型の設定ファイルを使用してポリシーを API に適用します。以下のポリシー定義とパラメーターの表を参照してください。
- policyRef:
name: credential-injection-oauth2-flex
config:
oauthService: <string> // REQUIRED
clientId: <string> // REQUIRED
clientSecret: <string> // REQUIRED
scope:
- <string> // OPTIONAL
overwrite: <boolean> // OPTIONAL
tokenFetchTimeout: <number> // OPTIONAL
allowRequestWithoutCredential: <boolean> // OPTIONAL
| パラメーター | 必須または省略可能 | デフォルト値 | 説明 |
|---|---|---|---|
|
必須 |
OAuth 2.0 サービスの URL。 |
|
|
必須 |
なし |
クライアント ID。 |
|
必須 |
なし |
クライアントシークレット。 |
|
省略可能 |
なし |
トークンに含めるスコープ。 |
|
省略可能 |
|
有効になっていると、ヘッダーが存在する場合に、新しい認証トークンを使用してこのポリシーで |
|
必須 |
10 |
サービスがトークンを返すまでに待機する秒数。 |
|
必須 |
|
有効になっていると、ポリシーがトークンを取得できない場合でも Flex Gateway は要求を送信します。 |
管理 Flex Gateway および Flex Gateway の接続モード
UI からポリシーを API インスタンスに適用するときに、以下のパラメーターが表示されます。
| パラメーター | 説明 | 必須 |
|---|---|---|
OAuth 2.0 service URL (OAuth 2.0 サービス URL) |
OAuth 2.0 サービスの URL。 |
必須 |
Client ID (クライアント ID) |
クライアント ID。 |
必須 |
Client secret (クライアントシークレット) |
クライアントシークレット。 |
必須 |
Scope (スコープ) |
トークンに含めるスコープ。 |
省略可能 |
Overwrite header (ヘッダーを上書き) |
有効になっていると、ヘッダーが存在する場合に、新しい認証トークンを使用してこのポリシーで |
必須 |
Token fetch timeout (トークン取得タイムアウト) |
サービスがトークンを返すまでに待機する秒数。 |
必須 |
Allow request without credential (ログイン情報のない要求を許可) |
有効になっていると、ポリシーがトークンを取得できない場合でも Flex Gateway は要求を送信します。 |
必須 |