Festlegung eines HTTP -Inhabersicherheitsschemas

Ein HTTP -Inhabersicherheitssystem wird verwendet, um Zugriffstoken zu generieren, die zwischen dem Server und dem Client ausgetauscht werden, wenn die API-Vorgänge aufgerufen werden.

Informationen zu dieser Task

Informationen zur Verwendung von Trägertokens mit OpenAPI 3-APIs finden Sie unter Bearer Authentication in der Spezifikation OpenAPI 3.

Wenn in der Anfrage ein HTTP -Bearer-Token gefunden wird, wird sein Wert im Kontext als api->security->bearer_token gespeichert. Wenn eine externe URL -Validierung aufgerufen wird, wird jede Antwort mit dem Statuscode 200 im Kontext als api->security->bearer_validation_response gespeichert.

Hinweis:
  • Diese Task bezieht sich auf die Konfiguration einer OpenAPI 3.0-API-Definition. Details zum Konfigurieren einer OpenAPI 2.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 2.0 -API-Definition.
  • OpenAPI 3.0 -APIs werden nur mit dem DataPower® API Gatewayunterstützt, nicht mit dem DataPower Gateway (v5 compatible).
  • Details zu aktuellen OpenAPI 3.0 -Unterstützungseinschränkungen finden Sie unter OpenAPI 3.0 -Unterstützung in IBM® API Connect.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Sie können jederzeit direkt zur zugrunde liegenden OpenAPI -YAML-Quelle wechseln, indem Sie auf das Symbol Quelle Symbol für OpenAPI -Quelleklicken. Klicken Sie auf das Symbol Formular Formularsymbol, um zum Designformular zurückzukehren.

Vorgehensweise

  1. Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 3.0 -API-Definitionbeschrieben.
  2. Erweitern Sie Komponenten > Sicherheitsschemas.
  3. Klicken Sie auf Add.
  4. Geben Sie im Dialogfenster Objekt hinzufügen die folgenden Informationen an:
    • Name des Sicherheitsschemas (Schlüssel) -Geben Sie einen beschreibenden Namen für das neue Schema ein.
    • Typ des Sicherheitsschemas -Wählen Sie httpaus.
    • Schema -Wählen Sie Trägeraus.
    • Bearer Format -Wählen Sie JWTaus.
    • Validierungsmethode -Wählen Sie eine Methode aus. Wenn Sie external-urlauswählen, geben Sie die folgenden zusätzlichen Informationen an:
      • Validierungsendpunkt – Geben Sie die URL des für die Validierung verwendeten Servers an. Um eine sichere Verbindung zu gewährleisten, sollte URL das https -Protokoll verwenden.
      • TLS-Profilname -Wenn der Validierungsendpunkt das https -Protokoll verwendet, wählen Sie den Namen des TLS-Clientprofils aus, das für eine sichere Verbindung verwendet wird.
    • Beschreibung -Geben Sie eine Beschreibung des JWT-Schemas an.
  5. Klicken Sie auf Create , um das neue Schema zu erstellen.
  6. Klicken Sie in der Seitenkopfzeile auf Speichern .