API に対するセキュリティー要件の適用

API に対してセキュリティー要件を適用するには、API セキュリティー構成のさまざまな側面を指定する、以前に作成されたセキュリティー・スキームを適用します。

このタスクについて

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

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

セキュリティー・スキーム定義を作成および構成する方法について詳しくは、 セキュリティー・スキームの定義を参照してください。

セキュリティー・スキームを API に適用する際には、以下の制限があります。
  • 1 つの API に 3 つ以上の API キー・セキュリティー・スキームを適用することはできません。
  • クライアント・シークレットの API キー・セキュリティー・スキームを適用する場合は、クライアント ID の API キー・セキュリティー・スキームも適用する必要があります。
  • クライアント ID とクライアント・シークレットの両方を指定することをアプリケーション開発者に求める場合は、2 つの個別の API キー・セキュリティー・スキームを適用する必要があります。
  • クライアント ID が要求ヘッダーで送信されるのか、照会パラメーターとして送信されるのかに関係なく、タイプがクライアント ID の APIキー・スキームを最大で 1 つ持つことができます。
  • クライアント・シークレットが要求ヘッダーで送信されるのか、照会パラメーターとして送信されるのかに関係なく、タイプがクライアント・シークレットの API キー・スキームを最大で 1 つ持つことができます。
  • 1 つの API に対して複数の基本セキュリティー・スキームを適用することはできません。 基本セキュリティー・スキームを適用する場合、OAuth セキュリティー・スキームも適用することはできません。
  • OAuth セキュリティー・スキームは 1 つまで API に適用できます。

セキュリティー要件は、API を正常に呼び出すためにすべての条件を満たす必要がある 1 つ以上のセキュリティー・スキームを指定します。 複数のセキュリティー要件を定義することができます。この場合、アプリケーションは、定義したいずれかのセキュリティー要件が満たされていると、API を呼び出すことができます。

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

手順

  1. OpenAPI 2.0 API 定義の編集の説明に従って、編集のために API を開きます。
  2. 「一般」を展開します。
  3. API の新しいセキュリティー要件を作成するには、以下のステップを実行します。
    1. ナビゲーション・ペインの 「セキュリティー」 の横にある追加アイコン OpenAPI 2.0 API 追加アイコン をクリックします。
    2. このセキュリティー要件に含めるセキュリティー・スキームを選択します。 リストされているセキュリティー・スキームは、定義されているものです。 セキュリティー・スキームの定義を参照してください。

      選択したセキュリティー・スキームのタイプが OAuth2の場合、必要なスコープを選択します。選択可能なスコープは、セキュリティー・スキームで指定されたスコープです。詳しくは、 OAuth2 セキュリティー・スキームの定義を参照してください。

      DataPower® API Gatewayによって強制される API に OAuth2 セキュリティー・スキームを適用する場合、セキュリティー・スキームに関連付けられたネイティブ OAuth プロバイダーで 「トークン生成後の拡張スコープ検査」 が有効になっていない場合にのみ、スコープを選択する必要があります。 ネイティブ OAuth プロバイダーでデフォルト・スコープが設定されていて、API 要求にスコープが含まれていない場合は、デフォルト・スコープが使用されます。詳しくは、 ネイティブ OAuth プロバイダーのスコープの構成を参照してください。

      注: OAuth サード・パーティー・プロバイダーで使用されるセキュリティー・スキームには、以下の追加要件が適用されます。 コンシューマー API を保護するために OAuth セキュリティー・スキームを選択する場合は、正しいプラン構成設定が適用されるようにセキュリティー資格情報に X-IBM-Client-Id または client_id が含まれていなければならないため、API キーのセキュリティー・スキームも含める必要があります。
    3. 「作成」 をクリックします。 セキュリティー・スキームの選択内容が表示されます。これらは、保存する前に再度変更することができます。
    4. 完了したら、 「実行依頼」 をクリックします。
  4. 既存のセキュリティー要件を変更するには、以下のステップを実行します。
    1. ナビゲーション・ペインで 「セキュリティー」 をクリックします。 事前に定義したすべてのセキュリティー要件がリストされ、各セキュリティー要件に含まれるセキュリティー・スキームが表示されます。
    2. セキュリティー要件のセキュリティー・スキームを変更するには、必要なセキュリティー要件の横にある編集アイコン セキュリティー要件編集アイコン をクリックし、必要に応じてセキュリティー要件の選択を変更します。
    3. 完了したら 「実行依頼」 をクリックし、 「保存」をクリックします。
    4. セキュリティー要件を削除するには、該当する削除アイコン セキュリティー要件削除アイコンをクリックし、 「削除」 をクリックして確認してから、 「保存」をクリックします。
    5. API のセキュリティーを無効にするには、 「以下のいずれかのセキュリティー要件が必要」 チェック・ボックスをクリアしてから、 「保存」をクリックします。