OIDC セキュリティー・スキーム・コンポーネントの定義

OIDC (OpenID Connect) セキュリティー・スキームは、OIDC プロバイダーを使用して API へのアクセスを制御するための設定を定義します。

開始前に

OIDCセキュリティスキームコンポーネントを作成するには、まずネイティブの OAuth プロバイダーを作成し、そのプロバイダーのOIDC設定を行う必要があります。
  1. OIDC プロバイダーを作成します。
  2. お使いのネイティブ OAuth プロバイダーのOIDCパラメータを設定してください

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. [コンポーネント ] > [セキュリティスキーム] を展開し、[] をクリック OpenAPI 3.0 API 追加アイコン して新しいセキュリティスキームを追加します。
  3. 「スキーマの追加」 ダイアログ・ボックスで、 「追加」をクリックする前に以下の設定を指定します。
    • セキュリティー・スキーム名 (キー): 新規スキームの名前を指定します。
    • セキュリティスキームの種類: 選択するopenIdConnect
    • OpenID Connect URL :OIDCプロバイダーの認可エンドポイント を入力します。 URL
  4. OpenId 「セキュリティー・スキームの接続」 ページで、OIDC プロバイダーに関する情報を追加します。
    • タイプ: リストから OIDC プロバイダーを選択します。

      このリストには、 OpenIDConnect の「ディスカバリーパス」フィールドにディスカバリー URL が指定され、OIDC用に構成されているネイティブの OAuth プロバイダーのうち、APIが使用するように構成されているカタログで有効化されているもののみが表示されます。

    • OpenID URL の接続 :プロバイダーを選択すると、ネイティブの OAuth プロバイダー用に設定された検出用 URL が、 URL に自動的に入力されます。
  5. 「保存」をクリックします。