基本認証セキュリティー定義の作成

API で基本認証セキュリティー定義を作成するときは、API 操作へのアクセスを認証するために使用する LDAP ユーザー・レジストリーまたは認証 URL の詳細を指定します。

このタスクについて

基本認証を使用した場合、API ユーザーは、選択された操作にアクセスするために、有効なユーザー名とパスワードを指定する必要があります。また、アプリケーション開発者は、基本認証を必要とする操作に送信される要求で HTTP 許可ヘッダーも指定する必要があります。

注: API Manager UI にもセキュリティー定義の作成および編集機能はあります。ただし、これらのタスクでは、以下で説明するように API Designer UI を使用する方法が推奨されます。特定の UI に固有のステップは、アイコンでマークを付けています。

認証 URL を使用すると、許可ヘッダー中に指定されたユーザー資格情報は、当該 URL に指定されたエンドポイントで妥当性検査が行われます。ユーザーが認証された場合、IBM® API Connect は、認証 URL が HTTP 200 OK 応答状況コードを返すことを予期します。他の HTTP 応答状況コードはすべて認証失敗に終わり、アクセスは拒否されます。

1 つの API に対して複数の基本セキュリティー定義を適用することはできません。基本セキュリティー定義を適用する場合、OAuth セキュリティー定義も適用することはできません。 セキュリティー定義の適用について詳しくは、API へのセキュリティー定義の適用を参照してください。

LDAP ユーザー・レジストリーを使用した認証について詳しくは、LDAP 認証を参照してください。

重要: IBM API Connect for IBM Cloud™ (SaaS オファリング)を使用している場合、使用する LDAP レジストリーは、インターネット上で見ることができる必要があり、社内イントラネット内からのみアクセス可能にすることはできません。

手順

基本認証セキュリティー定義を作成するには、以下のステップを実行します。

  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. 「セキュリティー定義 (Security Definitions)」セクションに移動します。
  6. 「セキュリティー定義 (Security Definitions)」セクションで、「セキュリティー定義の追加アイコン 「セキュリティー定義の追加」アイコン。 をクリックします。
  7. 「基本」を選択します。 基本セキュリティー定義が「セキュリティー定義」セクションに追加されます。
  8. セキュリティー定義の名前を入力してデフォルトの名前を置き換え、オプションで説明を入力します。
  9. 認証 URL を使用してユーザーを認証するために、以下のステップを実行します。
    1. 「認証 URL」を選択し、URL を指定します。 認証を確立する際、API Connect は認証 URL に対する GET 呼び出しを実行します。 この呼び出しが行われるときに、ユーザーから収集したユーザー名とパスワードが呼び出しの許可ヘッダーに組み込まれます。 これらが正しいことを確認し、アプリケーションのアクセスを許可する場合は 200 OK などの HTTP 成功コードで応答し、アクセスを拒否する場合は 401 Unauthorized などの HTTP エラー・コードで応答します。
    2. これは API Designer UI にのみ適用されることを示すアイコンTLS プロファイルを適用するには、「TLS プロファイル」をクリックし、目的の TLS プロファイルの名前を入力します。
    3. これは API Manager UI にのみ適用されることを示すアイコンTLS プロファイルを適用するには、「TLS プロファイル (TLS Profile)」をクリックして、目的の TLS プロファイルを選択します。
    注: TLS プロファイルは、管理サーバーで API Manager ユーザー・インターフェースを使用して作成する必要があります。詳しくは、TLS プロファイルを参照してください。
  10. LDAP ユーザー・レジストリーを使用してユーザーを認証するには、以下のステップを実行します。
    1. 「ユーザー・レジストリー」を選択します。
    2. これは API Designer UI にのみ適用されることを示すアイコン必要なレジストリーの名前を入力します。
    3. これは API Manager UI にのみ適用されることを示すアイコン必要なレジストリーを選択します。
    注: LDAP ユーザー・レジストリーは、管理サーバーで API Manager ユーザー・インターフェースを使用して作成する必要があります。詳しくは、LDAP レジストリーの作成を参照してください。
  11. 「保存」アイコン 「保存」アイコン。 をクリックして、変更を保存します。

次のタスク

セキュリティー定義を、API、または 1 つ以上の API 操作に適用します。詳しくは、『API へのセキュリティー定義の適用』および『API 操作へのセキュリティー定義の適用』を参照してください。

タイム・スタンプ・アイコン 最終更新: 2017 年 10 月 31 日