API のアプリケーション認証の構成

オンラインで編集する

アプリケーション認証の設定により、証明書を使用してAPIを保護することができます。 クライアント証明書を「 TLS 」クライアント証明書として送信するか、あるいは「 HTTP 」ヘッダー内に含めて送信するかを選択できます。

このタスクについて

注: このタスクは、 OpenAPI 3.0 API 定義の構成に関連しています。 OpenAPI 2.0 API 定義の構成方法について詳しくは、 OpenAPI 2.0 API 定義の編集を参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

「ソース 」アイコン OpenAPI ソース・アイコンをクリックすると、いつでも直接、基盤となる OpenAPI のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください フォーム・アイコン。

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. 以下のようにして、アプリケーション認証を有効にします。
    注: アプリケーションを識別するには、タイプ clientIDのセキュリティー要件を有効にする必要があります。
    1. 「ゲートウェイ」 タブを選択し、 「ゲートウェイおよびポータルの設定」を展開して、 「アプリケーション認証」をクリックします。
    2. 「証明書」を選択します。
  3. 以下のように、クライアント証明書をゲートウェイに送信する方法を指定します。
    1. ナビゲーション・ペインで、 「アプリケーション認証ソース」をクリックします。
      既存のアプリケーション認証ソース定義がリストされます。
    2. 「アプリケーション認証ソース」の横にある 「追加」をクリックします。
    3. ヘッダー を選択してください。

      APIが呼び出される際、指定された HTTP ヘッダーに X509 のクライアント証明書を指定する必要があります。 APIを呼び出すすべてのConsumer Catalogアプリケーションにおいて、 Consumer Catalog のユーザーインターフェースに証明書を入力する必要があります。

      ロード・バランサーを使用している場合は、ロード・バランサーを構成し、ロード・バランサーが TLS 通信を終了した後に、指定された HTTP ヘッダーを使用して適切なクライアント証明書をゲートウェイ・サービスに中継するようにする必要があります。

  4. 「作成」 をクリックします。
  5. 変更内容を保存するには、 「保存」 をクリックします。