BasicAuth プラグインは、API に HTTP Basic 認証を提供し、ユーザー名とパスワードを定義することでアクセスを制御できます。
BasicAuth を使用したクロスドメインのリソースアクセスについての詳細は、こちらの記事をご参照ください。
プラグイン設定
プラグインは JSON または YAML 形式で設定できます。どちらの形式も同じスキーマを使用します。設定形式を変換するには、YAML から JSON への変換ツールを検索してください。次の例は、YAML の設定テンプレートを示しています。
---
users:
- username: alice
password: 123456
- username: bob
password: 666666
- username: charlie
password: 888888
- username: dave
password: 111111
BasicAuth プラグインのプラグインデータセット対応
プラグインデータセットの作成
-
API Gateway コンソールにログインします。左側のナビゲーションペインで をクリックし、[プラグインデータセット] タブをクリックします。
-
右上で [データセットの作成] をクリックします。表示されるダイアログボックスで、データセットの [名前] を任意に設定し、[タイプ] を BASIC_AUTH_ACCESS に設定して、[OK] をクリックします。
-
作成したデータセットに移動します。右上で [データセットエントリの作成] をクリックします。表示されるページで、BasicAuth プラグインのユーザー名、パスワード、有効期間 (TTL) を設定します。
BasicAuth プラグイン設定:プラグインデータセットのサンプル
---
users:
- username: alice
password: 123456
usersDatasetId: 42f224a17a3e4bd9b098XXXXXXXX3f # BasicAuth プラグインデータセットの ID
説明
BasicAuth プラグインは、次の特殊文字をサポートしています:@、!、<、>、#、$、%、*。
プラグインデータセットについての詳細は、「プラグインデータセット」をご参照ください。