ibm-cloud-authentication

IBM Cloud Authentication ポリシーを使用して、 IBM Cloud で認証し、 watsonx.aiに要求を送信するときに使用できる API キーを取得します。

ゲートウェイのサポート

表 1. このポリシーをサポートするゲートウェイと、対応するポリシーのバージョンを示す表
ゲートウェイ	ポリシーのバージョン
DataPower® API Gateway	1.0.0

このトピックでは、 OpenAPI ソースでのポリシーの構成方法について説明します。アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について詳しくは、 IBM Cloud 認証を参照してください。

製品情報

ibm-cloud-authentication ポリシーは、 IBM Access Manager に API キーを提供し、正常に認証された場合は、後続のすべての watsonx.ai 操作要求で使用されるベアラー・トークンを返します。ベアラー・トークンはキャッシュされ、約 60 分間有効です。 API キーの応答がキャッシュされなかった場合は、新しいトークンが取得されます。または期限切れです。

プロパティ－

以下の表に、このポリシーのプロパティーをリストします。表には、プロパティーが必須かどうか、入力用の有効な値とデフォルト値、および値のデータ型が示されています。

表 2. ibm-cloud-authentication ポリシーのプロパティー
プロパティー・ラベル	必須	説明	データ・タイプ
version	はい	ポリシーのバージョン番号。使用しているゲートウェイと互換性のあるバージョンをポリシーに指定する必要があります。 API の公開時に、バージョンがゲートウェイと互換性がない場合、使用可能なバージョンを指定する検証エラーがスローされます。	ストリング
title	いいえ	ポリシーのタイトル。デフォルト値は「 `ibm-cloud-authentication`」です。タイトルは、UI の API アセンブリー・エディターに表示されます。	ストリング
description	いいえ	ポリシーの説明。	ストリング
apikey	はい	API キー、または API キーが含まれている変数への変数参照。 API キーは、後続の watsonx.ai 要求を認証するために使用されます。	ストリング

例

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