ログイン情報挿入基本認証ポリシー

ポリシー名

ログイン情報挿入基本認証

概要

発信要求に基本認証ヘッダーを挿入する

カテゴリ

セキュリティ

使用可能な最小 Flex Gateway バージョン

v1.9.0

返される状況コード

このポリシーの戻りコードは存在しません。アップストリームサービスからエラーコードが返されます。

概要

ログイン情報挿入基本認証ポリシーでは、ユーザー名とパスワードが含まれる Authorization ヘッダーを発信要求に挿入します。このポリシーにより、Flex Gateway からアップストリームサービスに送信される要求に必ず適切な認証ヘッダーが含まれるようになります。認証ヘッダーの形式は Authorization: Basic <username:password> です。

このポリシーは、基本 HTTP 認証標準に準拠します。

エラーが発生すると、このポリシーは WWW-Authenticate HTTP ヘッダー項目を返します。

ポリシーのパラメーターの設定

Flex Gateway のローカルモード

ローカルモードでは、宣言型の設定ファイルを使用してポリシーを API に適用します。以下のポリシー定義とパラメーターの表を参照してください。

- policyRef:
    name: credential-injection-basic-auth-flex
  config:
    username: <string> // OPTIONAL
    password: <string> // OPTIONAL
    overwrite: <boolean> // OPTIONAL
    customHeader: <string> // OPTIONAL

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`username`	省略可能	なし	基本認証ログイン情報に使用するユーザー名。
`password`	省略可能	なし	基本認証ログイン情報に使用するパスワード。
`overwrite`	省略可能	true	有効になっていると、`Authorization` ヘッダーが存在する場合に、設定済みのログイン情報を使用してこのポリシーで上書きします。
`customHeader`	省略可能	なし	設定されている場合、`Authorization` ヘッダーではなくカスタムヘッダーが挿入されます。[Overwrite header (ヘッダーを上書き)] が有効になっていると、このポリシーにより、`Authorization` ヘッダーではなくカスタムヘッダーを上書きします (存在する場合)。

username

省略可能

なし

基本認証ログイン情報に使用するユーザー名。

password

省略可能

なし

基本認証ログイン情報に使用するパスワード。

overwrite

省略可能

true

有効になっていると、Authorization ヘッダーが存在する場合に、設定済みのログイン情報を使用してこのポリシーで上書きします。

customHeader

省略可能

なし

設定されている場合、Authorization ヘッダーではなくカスタムヘッダーが挿入されます。[Overwrite header (ヘッダーを上書き)] が有効になっていると、このポリシーにより、Authorization ヘッダーではなくカスタムヘッダーを上書きします (存在する場合)。

リソースの設定例

- policyRef:
    name: http-basic-authentication-flex
  config:
    username: chris
    password: admin

管理 Flex Gateway および Flex Gateway の接続モード

UI からポリシーを API インスタンスに適用するときに、以下のパラメーターが表示されます。

パラメーター説明必須

パラメーター	説明	必須
Username (ユーザー名)	基本認証ログイン情報に使用するユーザー名。	省略可能
Password (パスワード)	基本認証ログイン情報に使用するパスワード。	省略可能
Overwrite header (ヘッダーを上書き)	有効になっていると、`Authorization` ヘッダーが存在する場合に、設定済みのログイン情報を使用してこのポリシーで上書きします。	省略可能
カスタムヘッダー	設定されている場合、`Authorization` ヘッダーではなくカスタムヘッダーが挿入されます。[Overwrite header (ヘッダーを上書き)] が有効になっていると、このポリシーにより、`Authorization` ヘッダーではなくカスタムヘッダーを上書きします (存在する場合)。	省略可能

Username (ユーザー名)

基本認証ログイン情報に使用するユーザー名。

省略可能

Password (パスワード)

基本認証ログイン情報に使用するパスワード。

省略可能

Overwrite header (ヘッダーを上書き)

有効になっていると、Authorization ヘッダーが存在する場合に、設定済みのログイン情報を使用してこのポリシーで上書きします。

省略可能

カスタムヘッダー

省略可能