基本的な認証プラグインを構成および使用する方法 - API Gateway

このトピックでは、API Gatewayが提供する基本的な認証プラグインについて説明します。 HTTP認証の詳細については、「HTTP認証」をご参照ください。

基本的な認証プラグインの設定

基本的な認証プラグインをJSONまたはYAML形式で設定できます。 2つの形式は同じスキーマを持ち、変換ツールを使用して互いに変換できます。次のコードは、YAML形式のテンプレートを提供します。

---
users:
  - username: alice
     password: 123456
  - username: bob
     password: 666666
  - username: charlie
     password: 888888
  - username: dave
     password: 111111

基本的な認証プラグインをプラグインデータセットと組み合わせて使用する

プラグインデータセットの作成

API Gatewayコンソールにログインします。左側のナビゲーションウィンドウで、[APIを開く] > [プラグイン] を選択します。表示されるページで、[カスタムデータセット] タブをクリックします。
右上隅の [データセットの作成] をクリックします。表示されるダイアログボックスで、データセットの名前を指定し、[タイプ] ドロップダウンリストから [BASIC_AUTH_ACCESS] を選択し、[確認] をクリックします。
作成したデータセットをクリックします。表示されるページで、[データセットエントリの作成] をクリックします。 [データセットエントリの作成] ダイアログボックスで、パラメーターを指定します。ユーザー名、パスワード、および有効期間が必要です。

例

---
users:
  - username: alice
    password: 123456
usersDatasetId: 42f224a17a3e4bd9b098XXXXXXXX3f # The dataset ID.

説明

基本的な認証プラグインは、@ 、! 、<、> 、# 、$、% 、および * の特殊文字をサポートしています。

プラグインデータセットの詳細については、「プラグインデータセット」をご参照ください。