OAuth2 セキュリティー・スキームの定義

OAuth2 セキュリティー・スキームは、OAuth 許可標準を使用して API 操作へのアクセスを制御するための設定を定義します。

1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
2. 既に 1 つ以上のセキュリティー・スキームが定義されている場合は、 「セキュリティー・スキーム」を展開します。
3. OAuth2 セキュリティー・スキームを作成するには、 「セキュリティー・スキーム」の横にある追加アイコン をクリックし、 oauth2を選択します。 既存の OAuth2 セキュリティー・スキームを編集するには、ナビゲーション・ペインでセキュリティー・スキーム名をクリックします。
4. 「セキュリティー・スキーム名」 フィールドに、選択した識別名を入力します。
5. 以下の情報を指定します。
   • セキュリティー・スキーム名: ユーザーが選択した識別名。
   • OAuth プロバイダー: 使用する OAuth プロバイダーを選択します。
   • フロー: 以下のいずれかのオプションを選択します。
     • 暗黙
     • リソース所有者 - パスワード
     • アプリケーション
     • アクセス・コード
     注: 選択可能なフロー・オプションは、選択した OAuth プロバイダーでサポートされているオプションによって異なります。

     OAuth プロバイダーの作成時に、サポートされる付与タイプとして 「リソース所有者-JWT」 を選択した場合は、このセキュリティー・スキームの 「フロー」 として 「リソース所有者-パスワード」 を選択する必要があります。

   • 説明 (オプション): OAuth2 セキュリティー・スキームの説明。 リッチ・テキスト表現には、 CommonMark 構文 を使用できます。
   • URL エンドポイント (フロー・タイプに応じて該当するエンドポイント):
     • 許可URL
     • トークンURL
     注： ここで提供されている URL エンドポイント値は、参考情報としてのみ維持されており、 API Connect によってそれらに検証やその他の処理は適用されません。 適用される OAuth セキュリティーは、指定された OAuth プロバイダーによって異なります。
   • スコープ (既存の OAuth2 セキュリティー・スキームを編集する場合に使用可能):
     • 新規スコープを追加するには、 「追加」をクリックします。 既存のスコープを編集するには、必要なスコープの横にあるオプション・アイコン をクリックしてから、 「編集」をクリックします。
     • 以下の情報を指定します。
       • スコープ: スコープ ID。
       • 説明 (オプション): スコープの説明。 リッチ・テキスト表現には、 CommonMark 構文 を使用できます。
       • 新規スコープを作成する場合は、 「作成」をクリックします。
6. 新しい OAuth2 セキュリティー・スキームを作成する場合は、 「作成」をクリックします。
   さらに編集するために、セキュリティー・スキームの詳細が表示されます。
7. 完了したら、 「保存」 をクリックします。