API へのセキュリティー定義の適用

セキュリティー定義には、そのセキュリティー定義を API に適用することによって、API 内の操作に対するアクセス制御要件を定義するためのセキュリティー設定が含まれます。

始める前に

API に 1 つ以上のセキュリティー定義を作成します。詳しくは、セキュリティー定義の作成を参照してください。

このタスクについて

セキュリティー定義を API に適用する際には、以下の制限があります。
  • 1 つの API に 3 つ以上の API キー・セキュリティー定義を適用することはできません。
  • クライアント・シークレットの API キー・セキュリティー定義を適用する場合は、クライアント ID の API キー・セキュリティー定義も適用する必要があります。
  • クライアント ID とクライアント・シークレットの両方を指定することをアプリケーション開発者に求める場合は、2 つの個別の API キー・セキュリティー定義を適用する必要があります。
  • クライアント ID が要求ヘッダーで送信されるのか、照会パラメーターとして送信されるのかに関係なく、タイプがクライアント ID の APIキー定義を最大で 1 つ持つことができます。
  • クライアント・シークレットが要求ヘッダーで送信されるのか、照会パラメーターとして送信されるのかに関係なく、タイプがクライアント・シークレットの APIキー定義を最大で 1 つ持つことができます。
  • 1 つの API に対して複数の基本セキュリティー定義を適用することはできません。基本セキュリティー定義を適用する場合、OAuth セキュリティー定義も適用することはできません。
  • [V5.0.7 以前] コンシューマー API を保護するために OAuth セキュリティー定義を選択する場合は、正しいプラン構成設定が適用されるようにセキュリティー資格情報に X-IBM-Client-Id または client_id が含まれていなければならないため、API キーのセキュリティー定義も含める必要があります。
  • 1 つの API に対して複数の OAuth セキュリティー定義を適用する場合、そのすべてが同じクライアント・タイプ設定 (公開または機密) でなければなりません。
  • 1 つの API に対して複数の OAuth セキュリティー定義を適用する場合、それらの認証設定は互換性がなければなりません。つまり、認証プロパティーの値は、そのプロパティーが設定された、適用済み OAuth セキュリティー・スキームすべてについて、同じでなければなりません。
  • 1 つの API に対して複数の OAuth セキュリティー定義を適用する場合、それらのトークンの更新と失効設定はすべて互換性がなければなければなりません。つまり、トークンの更新と失効認証プロパティーの値は、そのプロパティーが設定された、適用済み OAuth セキュリティー・スキームすべてについて、同じでなければなりません。
注: API Manager UI にもセキュリティー定義を適用する機能はあります。ただし、これらのタスクでは、以下で説明するように API Designer UI を使用する方法が推奨されます。特定の UI に固有のステップは、アイコンでマークを付けています。

手順

セキュリティー定義を API に適用するには、以下のステップを実行します。

  1. これは API Designer UI にのみ適用されることを示すアイコン「API」をクリックします。API」タブが開きます。
  2. これは API Manager UI にのみ適用されることを示すアイコン前に UI ナビゲーション・ペインをピン留めしていなかった場合は、「ナビゲート先」アイコン 「ナビゲート先」アイコンをクリックします。 API Manager UI ナビゲーション・ペインが開きます。UI ナビゲーション・ペインをピン留めするには、「メニューのピン留め」アイコン 「メニューのピン留め」アイコン をクリックします。
  3. これは API Manager UI にのみ適用されることを示すアイコンUI ナビゲーション・ペインの「ドラフト」をクリックし、「API」をクリックします。API」タブが開きます。
  4. 定義を既存の API に適用するには、作業する API をクリックします。定義を適用する前に新規 API を作成する場合は、API 定義の作成を参照してください。
  5. 「セキュリティー」セクションに移動します。
  6. 「セキュリティー」セクションで、適用するセキュリティー定義を選択します。
    注: コンシューマー API を保護するために OAuth セキュリティー定義を選択する場合は、正しいプラン構成設定が適用されるようにセキュリティー資格情報に X-IBM-Client-Id または client_id が含まれていなければならないため、API キーのセキュリティー定義も含める必要があります。
    選択した定義が API に適用されます。
  7. セキュリティー定義を削除して API に適用されないようにするには、そのセキュリティー定義の選択をクリアします。
  8. 「保存」アイコン 「保存」アイコン。 をクリックして、変更を保存します。
タイム・スタンプ・アイコン 最終更新: 2017 年 10 月 31 日