ibm-cloud-authentifizierung

Verwenden Sie die Richtlinie IBM Cloud Authentication , um sich bei IBM Cloud zu authentifizieren und einen API-Schlüssel abzurufen, der beim Senden von Anforderungen an watsonx.aiverwendet wird.

Gateway-Unterstützung

Tabelle 1. Tabelle, in der angegeben wird, welche Gateways diese Richtlinie unterstützen, sowie die entsprechende Richtlinienversion
Gateway	Richtlinienversion
DataPower® API Gateway	1.0.0

In diesem Abschnitt wird beschrieben, wie Sie die Richtlinie in Ihrer OpenAPI -Quelle konfigurieren können. Details zur Konfiguration der Richtlinie in der Assembly-Benutzeroberfläche finden Sie unter IBM Cloud Authentication.

Produktinfo

Die Richtlinie 'ibm-cloud-authentication' stellt einen API-Schlüssel für den IBM Access Manager bereit und gibt nach erfolgreicher Authentifizierung ein Trägertoken zurück, das von allen nachfolgenden watsonx.ai -Operationsanforderungen verwendet werden soll. Das Trägertoken wird zwischengespeichert und ist ungefähr 60 Minuten lang gültig. Es wird ein neues Token abgerufen, wenn eine Antwort für den API-Schlüssel nicht zwischengespeichert wurde. oder abgelaufen.

Eigenschaften

Die folgende Tabelle enthält die Richtlinieneigenschaften, gibt an, ob eine Eigenschaft erforderlich ist, enthält die gültigen Werte und die Standardwerte für Eingaben und gibt den jeweiligen Datentyp der Werte an.

Tabelle 2. Eigenschaften der Richtlinie 'ibm-cloud-authentication'
Eigenschaftsbezeichnung	Erforderlich	Beschreibung	Datentyp
version	Ja	Die Versionsnummer der Richtlinie. Sie müssen eine Version für die Richtlinie angeben, die mit dem verwendeten Gateway kompatibel ist. Wenn die API veröffentlicht wird und die Version nicht mit dem Gateway kompatibel ist, wird ein Gültigkeitsfehler ausgelöst, der die verfügbaren Versionen angibt.	Zeichenfolge
title	Nein	Der Titel der Richtlinie; der Standardwert ist `ibm-cloud-authentication`. Der Titel wird im API-Assembly-Editor in der Benutzerschnittstelle angezeigt.	Zeichenfolge
description	Nein	Eine Beschreibung der Richtlinie.	Zeichenfolge
apikey	Ja	Der API-Schlüssel oder ein Variablenverweis auf die Variable, die einen API-Schlüssel enthält Der API-Schlüssel wird zur Authentifizierung nachfolgender watsonx.ai -Anforderungen verwendet.	Zeichenfolge

Beispiel

- ibm-cloud-authentication:
    version: 2.0.0
    title: ibm-cloud-authentication
    apikey: $(watsonx-ai-apikey)