OIDC-Sicherheitsschemakomponenten definieren

Ein OIDC-Sicherheitsschema (OpenID Connect) definiert Einstellungen für die Verwendung Ihres OIDC-Providers zur Steuerung des Zugriffs auf die API.

Vorbereitende Schritte

Bevor Sie eine OIDC-Sicherheitsschemakomponente erstellen, müssen Sie einen nativen OAuth-Provider erstellen und die OIDC-Einstellungen für ihn konfigurieren.
  1. Erstellen Sie einen OIDC-Provider.
  2. Konfigurieren Sie die OIDC-Parameter für Ihren nativen OAuth-Provider.

Vorgehensweise

  1. Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 3.0 -API-Definitionbeschrieben.
  2. Erweitern Sie Komponenten > Sicherheitsschemata und klicken Sie anschließend auf OpenAPI 3.0 Symbol für Hinzufügen von APIs , um ein neues Sicherheitsschema hinzuzufügen.
  3. Geben Sie im Dialogfenster Schema hinzufügen die folgenden Einstellungen an, bevor Sie auf Hinzufügenklicken.
    • Name des Sicherheitsschemas (Schlüssel): Geben Sie einen Namen für das neue Schema an.
    • Sicherheitsschematyp: wählen openIdConnect
    • OpenID Verbinden Sie URL : Geben Sie den Autorisierungsendpunkt URL für den OIDC-Anbieter ein.
  4. Fügen Sie auf der Seite OpenId Connect Security Scheme Informationen zum OIDC-Provider hinzu.
    • Typ: Wählen Sie Ihren OID-Provider aus der Liste aus.

      Die Liste zeigt nur die nativen OAuth-Anbieter an, die für OIDC mit einer im Feld " OpenIDConnect Discovery path" angegebenen Discovery URL konfiguriert und für den Katalog aktiviert sind, für dessen Verwendung die API konfiguriert ist.

    • OpenID Verbinden Sie URL : Wenn Sie Ihren Anbieter auswählen, wird URL für Sie mit der Discovery- URL ausgefüllt, die für den nativen OAuth-Anbieter konfiguriert wurde.
  5. Klicken Sie auf Speichern.