基本認証セキュリティー・スキーム・コンポーネントの定義

基本認証セキュリティー・スキーム・コンポーネントは、API を呼び出すアプリケーションがユーザー・レジストリーを介して認証を行う必要がある場合に使用されます。

開始前に

ゲートウェイで適用されるAPIの操作へのアクセスを認証するために、以下のユーザー登録タイプがサポートされています：

認証URL
LDAP

以下のユーザー・レジストリー・タイプはサポートされて いません 。

OpenID Connect (OIDC)
ローカル・ユーザー・レジストリー (LUR)
カスタム・ユーザー・レジストリー

API 内に基本認証セキュリティー定義を作成する前に、ユーザー・レジストリーが存在している必要があります。ユーザー・レジストリーを作成するには、 API Manager または Cloud Managerのいずれかを使用できます。 API Managerでレジストリーを作成すると、そのレジストリーはプロバイダー組織にのみ表示されます。 Cloud Managerでレジストリーを作成すると、そのレジストリーを複数のプロバイダー組織から可視にすることができます。

API Managerでユーザー・レジストリーを作成するには、ユーザー・レジストリーの操作を参照してください。

このタスクについて

注:

このタスクは OpenAPI 3.0 API 定義の構成に関連しています。 OpenAPI 2.0 API 定義の構成方法について詳しくは、 OpenAPI 2.0 API 定義の編集を参照してください。
OpenAPI 3.0 API は、 DataPower® API Gatewayでのみサポートされ、 DataPower Gateway (v5 compatible)ではサポートされません。
現在の OpenAPI 3.0 サポートの制限について詳しくは、 IBM® API Connect での OpenAPI 3.0 のサポートを参照してください。

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

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

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

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

「Authentication URL 」の使用方法については、「Authentication URL user registry」を参照してください。

基本認証セキュリティー・スキーム・コンポーネントを使用するには、API 定義内の他の場所から参照する必要があります。詳細については、「API に対するセキュリティ要件の適用」および「操作に対するセキュリティ要件の適用」を参照してください。

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

手順

OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
「コンポーネント」を展開し、既に 1 つ以上のセキュリティー・スキーム・コンポーネントが定義されている場合は、「セキュリティー・スキーム」を展開します。
基本認証セキュリティスキームのコンポーネントを作成するには、「セキュリティスキーム」の横にある追加アイコンをクリックします。既存の基本認証セキュリティー・スキーム・コンポーネントを編集するには、ナビゲーション・ペインで対象のコンポーネント名をクリックします。
新しい基本認証セキュリティー・スキーム・コンポーネントを作成する場合は、最初から作成することも、他の基本認証セキュリティー・スキーム・コンポーネントを参照することもできます。
最初から基本認証セキュリティー・スキーム・コンポーネントを作成するには、「定義」タブで以下の情報を指定します。
- セキュリティー・スキーム名 (必須): API 定義内の他の場所からこの基本認証セキュリティー・スキーム・コンポーネントを参照できるようにするためのキー。参照の形式は次のとおりです。
```
#/components/securitySchemes/Security_Scheme_Name
```
- セキュリティー・スキーム・タイプ (必須): 「http」を選択します。
- スキーム（必須）： RFC7235 で定義されている、Authorization ヘッダーで使用する HTTP 認証スキームの名前。
- ユーザー・レジストリーを使用して認証: 認証に使用するユーザー・レジストリーの名前。これは、ユーザー・レジストリーの作成時に自動生成された name フィールドの値です。
- ベアラー・フォーマット: クライアントがベアラー・トークンの形式を識別するためのヒント。通常、ベアラー・トークンは、許可サーバーによって生成されるため、この情報は主に文書化を目的としています。
- 説明 (オプション): 基本認証セキュリティー・スキームの説明。リッチテキストの表現には、 CommonMark 構文を使用できます。
別の基本認証セキュリティー・スキーム・コンポーネントを参照するには、「参照」タブで以下の情報を指定します。
- セキュリティー・スキーム名 (必須): API 定義内の他の場所からこの基本認証セキュリティー・スキーム・コンポーネントを参照できるようにするためのキー。参照の形式は次のとおりです。
```
#/components/securitySchemes/Security_Scheme_Name
```
- 参照元 (Reference from): 別の基本認証セキュリティー・スキーム・コンポーネントへの参照を選択します。
新しい基本認証セキュリティー・スキーム・コンポーネントを作成する場合は、「作成」をクリックします。
セキュリティー・スキーム・コンポーネントの詳細が表示され、さらに編集することができます。
完了したら、「保存」をクリックします。

次のタスク

セキュリティー・スキームを API または操作に適用します。詳細については、「API に対するセキュリティ要件の適用」および「操作に対するセキュリティ要件の適用」を参照してください。

LDAP および認証に関する詳細については、 URL および LDAP をご覧ください。また、ユーザー登録に関する認証については、 URL をご覧ください。