API Gateway:コンシューマーの管理

Cloud-native API Gateway コンソールの [コンシューマー] ページに移動し、コンシューマーを作成するリージョンを選択します。

[コンシューマーの作成] をクリックします。[コンシューマーの作成] パネルで、[コンシューマー名] を設定し、認証方式として [API キー] を選択し、次の設定を完了します。

• 生成方法:

  • [システム生成]: システムが自動的に API キーの認証情報を生成します。

  • [カスタム]: API キーの認証情報と認証情報のソースを指定する必要があります。

• 認証情報 ([システム生成] が選択されている場合は不要): API キーの認証情報をカスタマイズします。

• 認証情報ソース:

  リクエストから API キーを抽出する場所をゲートウェイに伝えます。ソースには次のものが含まれます。

  • [Authorization: Bearer <token>] (標準トークンフォーマット)

  • [カスタム HTTP ヘッダー] (例: X-API-Key: your-key)

  • [カスタムクエリパラメーター] (例: ?apikey=your-key)

Cloud-native API Gateway コンソールの [コンシューマー] ページに移動し、コンシューマーを作成するリージョンを選択します。

[コンシューマーの作成] をクリックします。[コンシューマーの作成] パネルで、[コンシューマー名] を設定し、認証方式として [JWT] を選択し、次の設定を完了します。

• 作成方法:

  • [ローカル設定] は、認証サービスとゲートウェイが同じクラスターまたはローカルエリアネットワーク (LAN) 内にあり、高いパフォーマンス要件と頻繁でないキー変更があるシナリオに適しています。

  • [リモートフェッチ] は、統合 ID センター (OAuth2、OpenID Connect など) を使用して JWT を発行するシナリオに適しており、動的なキー更新をサポートし、マルチテナントまたは本番環境に適しています。

• キータイプ ([リモートフェッチ] が選択されている場合は不要):

  • [対称キー]: デフォルトの JWKS が生成されます。JWKS はコンシューマーによって異なります。デフォルトの JWKS には、トークンの暗号化または復号に使用されるキーが含まれています。

  • [非対称キー]: 完全な JWKS 構成を入力する必要があります。トークンは秘密鍵を使用して暗号化されます。ゲートウェイは JWKS の公開鍵に基づいて復号を実行します。

• JWKS:

  • [ローカル設定] が選択されている場合、JWKS 構成を設定します。JWKS の仕様の詳細については、「JSON Web Key (JWK)」をご参照ください。

  • [リモートフェッチ] が選択されている場合、URL を設定します。システムは、ポート番号、タイムアウト、キャッシュ時間などの情報を自動的に解析して読み取ります。

    重要

    URL はドメイン名である必要があり、IP アドレスであってはなりません。

• JWT トークン: JWT トークン情報を設定します。

  • [タイプ]: トークンのタイプ。デフォルト値: HEADER。

  • [キー]: トークンの名前。

  • [プレフィックス]: トークンのプレフィックス。トークンを検証するために必要なパラメーターを設定します。デフォルトでは、トークンには Bearer プレフィックスが含まれ、Authorization Header に保存されます。例: Authorization: Bearer token。

  • [パススルーを有効にする]: このオプションを選択すると、トークンはバックエンドサービスに透過的に渡されます。

• JWT ペイロード内のコンシューマー ID: コンシューマーを識別するために使用される JWT ペイロード内のキーと値。デフォルトでは、キーは uid で、値はランダムな文字列です。ビジネス要件に基づいて値を変更できます。次のコードは、JWT トークン内のペイロードの例です。

  {
    "uid": "11215ac069234abcb8944232b79ae711"
  }

Cloud-native API Gateway コンソールの [コンシューマー] ページに移動し、コンシューマーを作成するリージョンを選択します。

[コンシューマーの作成] をクリックします。[コンシューマーの作成] パネルで、[コンシューマー名] を設定し、認証方式として [HMAC] を選択し、次の設定を完了します。

• [システム生成]: システムが自動的に AccessKey ペアを生成します。

• [カスタム]: AccessKey ペアを指定する必要があります。