APIキー
ブラウザーベースのサインインなしで自動化ワークフロー向けにBobを認証します。トライアルおよび有料プランのユーザーが利用できます。キーを個別に、またはインスタンス管理者としてまとめて管理できます。
所有権と管理
APIキーはユーザーとサブスクリプションインスタンスの両方にスコープされています。個々のユーザーは自分のAPIキーを作成、一覧表示、および失効させることができます。サブスクリプションインスタンスの管理者は、インスタンス内のすべてのユーザーのAPIキーを一覧表示および失効させることができます。
APIキーの種類
作成できるAPIキーは2種類あります：
| 種類 | スコープと用途 |
|---|---|
| 汎用 | サブスクリプションインスタンスにスコープされ、複数のサービスで使用可能です。推論リクエストにはチームIDヘッダーも含める必要があります。 |
| 推論 | 特定のサブスクリプションインスタンスとチームにスコープされ、推論リクエストのみに限定されます。インスタンスやチームの追加ヘッダーは不要です。 |
APIキーを使う場面
以下のような場合にAPIキーを使用します：
- 非対話型セッションでBob Shellを認証する
- CI/CDパイプラインやスケジュール自動化でBobを実行する
- スクリプト化されたワークフローでブラウザーベースのサインインを回避する
- 汎用または推論APIキーで推論リクエストを認証する
APIキーを作成する
bob.ibm.com にアクセスしてログインします。
サブスクリプションインスタンスを開き、APIキー管理セクションに移動します。
新しいAPIキーを作成し、作成するキーの種類を選択します。
APIキーの値をコピーして安全に保管します。
警告：
APIキーの値は作成後に再表示できません。
APIキーを管理する
APIキー管理セクションで以下の操作ができます：
- APIキーの一覧表示
- キーの検索とフィルタリング
- APIキーの詳細表示
- アクティブなキーの失効
- 失効済みキーをアクティブおよび期限切れのキーと並べて表示
管理者の機能
サブスクリプションインスタンスの管理者はインスタンス全体のAPIキーを管理できます。管理者の機能には以下が含まれます：
- インスタンス内のすべてのユーザーのAPIキーの一覧表示
- インスタンス内の任意のユーザーのAPIキーの失効
- アクティブ、失効済み、および期限切れのキーの表示
Bob ShellでAPIキーを使用する
Bob ShellでAPIキーを使用するには、Bob Shellのインストールとセットアップおよび非対話型セッションの開始を参照してください。
このトピックはいかがですか？