メインコンテンツへスキップ
APIキーは、ツールの実行、ToolSetの管理、実行履歴の参照など、Jinba Toolbox APIへのプログラムからのリクエストを認証します。キーは組織にスコープされ、その組織のリソースへのMemberレベルのアクセスを提供し、1つのToolSet環境(指定しない場合はdefault)に紐付けられます。

APIキーの仕組み

すべてのAPIキーはjtb_プレフィックスを使用します。キーを作成すると、作成ダイアログに完全なキー値が表示されます。以降、一覧にはマスクされたプレフィックス(先頭12文字。例:jtb_abc12345...)のみが表示されますが、横のコピーボタンで完全なキーを再取得できます(キーの暗号化機能が導入された後に作成されたキーのみ)。 APIキーは作成された組織に紐付けられます。組織AのキーでOrganization Bのリソースにアクセスすることはできません(公開ツールの実行を除く。公開ツールは有効なキーであればどれでも実行可能です)。

APIキーの作成

1

API Keysに移動

組織のサイドバーでAPI Keysを開きます。既存のキーの一覧が表示されます(ある場合)。
2

キーの作成をクリック

ページ上部のCreate API Keyボタンをクリックします。モーダルが表示されます。
3

名前と環境を入力

キーの用途を識別するための分かりやすい名前を付けます(例:「Production Backend」、「CI/CD Pipeline」、「Local Development」)。この名前は参照用であり、キーの権限には影響しません。キーが接続するEnvironmentを選択します(デフォルト:default)。このキーで行う実行には、そのToolSet環境の変数とアクティブバージョンが使用されます。
4

キーをコピー

Create Keyをクリックすると、完全なAPIキーが表示されます。すぐにコピーして安全な場所に保存してください。
キーはシークレットとして扱ってください。ご利用のToolboxでキーの暗号化が有効になる前に作成されたキーは、後から再取得できません。
5

完了

Doneをクリックしてモーダルを閉じます。新しいキーが一覧に表示され、名前、マスクされたプレフィックス、環境、発行者、最終使用日、作成日が確認できます。

APIキー一覧

API Keysページには以下のカラムを持つテーブルが表示されます:

APIキーの削除

キーを削除するには、一覧のキーの横にある削除アクションをクリックします。Delete API Keyの確認ダイアログが表示されます。削除すると:
  • キーは即座に無効化されます。
  • このキーを使用するすべてのAPIリクエストは401 Unauthorizedエラーを返します。
  • この操作は永続的で元に戻すことはできません。
Memberは自分が発行したキーのみ削除できます。OwnerとAdminは組織内の任意のキーを削除できます。
キーの削除は、過去の実行記録やデータには影響しません。そのキーを使用した将来のAPI呼び出しのみが防止されます。

権限

APIキーに個別のスコープはありません。すべてのキーは組織のMemberロールとして動作します。ToolSetとツールの読み取り・作成・更新・削除・公開、公開済みツールの実行とMCPエンドポイントの呼び出し、実行記録とクレジットの読み取りが可能です。サインイン済みユーザーが必要な操作(ドラフトコードのテスト(/test)、バージョンの公開、APIキーの作成・表示・削除)や、Owner/Admin限定の操作(Webhook、クレジットの購入、他者のキーの削除)はAPIキーでは行えません。

APIキーの使用

REST API

Authorizationヘッダーにキーを含めます:

TypeScript SDK

SDKクライアントの作成時にキーを渡します:

MCP Endpoint

AIエージェントをToolSetのMCPエンドポイントに接続する際は、接続設定の一部としてAPIキーを提供します。MCPエンドポイントURLは、MCPスイッチがオンでバージョンが公開済みの場合にToolSetのToolsタブに表示されます。そこにあるConnect with JinbaAppボタンは、JinbaApp Connection ({environment})という名前のキーを自動的に作成(または再利用)します。

APIキーの管理場所

すべてのAPIキーは組織に属します。同じキーを2つのコンソールページから管理できます:

ベストプラクティス

  • 分かりやすい名前を付ける — 用途と環境でキーに名前を付けます(例:「Production API Server」、「Staging CI」)。必要な場合にどのキーを失効させるべきか特定しやすくなります。
  • 定期的にキーをローテーションする — 漏洩の影響を限定するために、定期的に新しいキーを作成し、古いキーを失効させます。
  • キーをソースコードにコミットしない — キーは環境変数またはシークレット管理ツールに保存します。
  • 環境ごとに別々のキーを使用する — 開発、ステージング、本番環境ごとに個別のキーを作成します。
  • 未使用のキーを失効させる — キーが不要になったら、すぐに失効させます。「Last Used」カラムを確認して、使用されていないキーを特定します。
  • 環境プロファイルごとにキーを分ける — キーはToolSet環境に紐付けられるため、defaultと追加した各環境に対して別々のキーを作成します。