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 Connect URL :プロバイダーを選択すると、 にネイティブOAuthプロバイダー用に設定されたディスカバリー が入力されます。 URL URL
  5. 「保存」をクリックします。