apiKeyHelper

settings.json型string記述場所どの設定ファイルでも可

認証情報を出力するスクリプトへのパスを指定します。

記述例

{
  "apiKeyHelper": "/bin/generate_temp_api_key.sh"
}

使い方・用途

  • 外部のパスワードマネージャーや Vault から、動的に変化する API キーやトークンを自動取得したい場合に使用します。
  • CI/CD パイプラインなどの非対話的な環境で、ブラウザログインなしに認証を済ませたい場合に役立ちます。
  • 認証情報が失効した際(デフォルト 5 分後)にスクリプトを再実行し、シームレスに更新できます。
英語原文

Path to a script that outputs authentication values. See https://code.claude.com/docs/en/settings#available-settings

関連ドキュメント

関連する変更履歴

v2.1.317(1件)

ベース URL として設定された LLM ゲートウェイがサーバー側の安全チェックに 403 または 422 を返す場合に、オートモードが毎ターン失敗する問題を修正した(apiKeyHelper 使用時の 403 は従来どおり)
英語原文を表示
Fixed auto mode failing every turn when an LLM gateway set as the base URL answers 403 or 422 to its server-side safety check (a 403 with an apiKeyHelper is unchanged)

関連ドキュメント

v2.1.314(1件)

MDM とリモート設定がベース URL や apiKeyHelper について異なる場合に、保存済みの claude.ai、Team、Enterprise のログインが動作する挙動を改善した
英語原文を表示
Improved the behavior of stored claude.ai, Team, and Enterprise logins when MDM and remote settings differ on base URL or apiKeyHelper

変更後

MDM ポリシーとリモート設定でベース URL や apiKeyHelper が異なる場合でも、保存された claude.ai・Team・Enterprise のログイン情報が適切に扱われるようになり、組織で管理された環境でログイン状態が安定して維持できるようになりました。

関連ドキュメント

v2.1.299(1件)

拒否されたクラウドセッションのエラーを修正した。apiKeyHelper のキー使用時に誤った組織が表示されることがあった。
英語原文を表示
Fixed the error for a denied cloud session, which could point to the wrong organization when a key from apiKeyHelper was in use

v2.1.284(1件)

マネージド設定がサインイン(forceLoginMethod または forceLoginOrgUUID)と API キー・トークン・apiKeyHelper の設定を要求する場合の起動時の拒否を改善した。現在使用中の認証情報、その設定場所、削除方法を示すようになった
英語原文を表示
Improved the startup refusal when managed settings require a sign-in (forceLoginMethod or forceLoginOrgUUID) and an API key, token or apiKeyHelper is configured: it now names the credential in use, where it is set, and how to remove it

変更後

組織のポリシーでサインインが強制されている環境で API キーやトークンなどの資格情報が原因で起動できなかったとき、どの資格情報がどこで設定されていて、どう削除すればよいかがエラーメッセージから分かるようになり、問題を素早く解消して起動できる。

関連ドキュメント

v2.1.274(1件)

/status が、自らのエラーバナーで確認を促していた apiKeyHelper の失敗を表示しない問題を修正した
英語原文を表示
Fixed /status not showing the apiKeyHelper failure that its own error banner told you to check

関連ドキュメント

v2.1.266(1件)

LLM ゲートウェイやプロキシ構成に影響する 2.1.265 のリグレッションを修正した。ドキュメント化されていない CLAUDE_CODE_USE_GATEWAY 環境変数は、以前は ANTHROPIC_BASE_URL と ANTHROPIC_AUTH_TOKEN が両方設定されている場合を除き無視されていたが、2.1.265 ではこの変数が単独で Cloud ゲートウェイへのサインインを強制するようになり、API キー、apiKeyHelper、カスタム認証ヘッダーと併せて設定していた構成では、すべてのリクエストが 'Not signed in to the Cloud gateway' で失敗するようになった。この変数は単独では再び無視されるようになり、設定の変更は不要である。
英語原文を表示
Fixed a 2.1.265 regression affecting LLM-gateway and proxy setups: the undocumented CLAUDE_CODE_USE_GATEWAY environment variable, previously ignored unless ANTHROPIC_BASE_URL and ANTHROPIC_AUTH_TOKEN were both set, began forcing Cloud-gateway sign-in on its own in 2.1.265, so configurations that set it alongside an API key, apiKeyHelper, or custom auth headers failed every request with "Not signed in to the Cloud gateway". The variable on its own is ignored again; no configuration change is needed

関連ドキュメント

v2.1.248(1件)

apiKeyHelper が唯一の認証情報である場合に、ゲートウェイモデルディスカバリー(CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY)が一切実行されない問題を修正した
英語原文を表示
Fixed gateway model discovery (CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY) never running when apiKeyHelper is the only credential

関連ドキュメント

v2.1.246(2件)

apiKeyHelper が短命な JWT を返す場合に、アイドル後の最初のプロンプトで API エラーが表示される問題を修正した。期限切れのキャッシュトークンは送信前に更新されるようになり、401/403 の認証エラーは静かにリトライする
英語原文を表示
Fixed a visible API error on the first prompt after idle when apiKeyHelper returns short-lived JWTs: an expired cached token is now refreshed before sending, and 401/403 auth errors retry quietly

関連ドキュメント

使用状況テレメトリの組織への帰属を改善した。ワークロード ID フェデレーションセッション、起動時に apiKeyHelper が実行されている間に送信されるイベント、アイドル中にログイントークンが期限切れになった後のイベントが対象となる
英語原文を表示
Improved attribution of usage telemetry to your organization for workload identity federation sessions, events sent while apiKeyHelper runs at startup, and after a login token expired while idle

変更後

Workload Identity Federation のセッションや起動時に apiKeyHelper が実行されている間、アイドル中にログイントークンが期限切れになった後などに送信された利用状況テレメトリも、正しく組織に紐付けられるようになった。これにより、こうした場面での利用データが組織の利用状況集計から漏れなくなる。

関連ドキュメント

v2.1.208(1件)

apiKeyHelper スクリプトの失敗が一般的な 401 エラーの影に隠れてしまう問題を修正した。10回の無言のリトライを待たず、3回以内の試行でスクリプト自体のエラーが表示されるようになった。
英語原文を表示
Fixed apiKeyHelper script failures being hidden behind a generic 401 after ~10 silent retries; the script's own error is now shown within 3 attempts

変更後

API キー取得スクリプトが壊れた際に、ネットワークエラーなのかスクリプトのバグなのかを悩む必要がなくなります。

関連ドキュメント

v2.1.141(1件)

デスクトップ版やサードパーティプロバイダーで、ホスト側のmanaged-settingsから認証情報を誤って引き継いでしまう問題を修正。
英語原文を表示
Fixed desktop and third-party provider sessions incorrectly inheriting apiKeyHelper/ANTHROPIC_AUTH_TOKEN from host managed-settings

変更後

意図しないAPIキーの利用や認証エラーを防ぎ、セキュアで一貫した認証体験が得られます。

関連ドキュメント

v2.1.139(1件)

APIキー等が設定されている場合、Remote Controlや通知設定等の一部機能を無効化するよう変更(APIキーを優先するため)。
英語原文を表示
Remote Control, /schedule, claude.ai MCP connectors, and notification preferences are now disabled when ANTHROPIC_API_KEY / apiKeyHelper / ANTHROPIC_AUTH_TOKEN is set, even if a Claude.ai login also exists. Unset the API key to use these features

変更後

認証方式による機能の挙動が明確になり、セキュアで予測可能な利用環境が保証されます。

関連ドキュメント

v2.1.101(1件)

Amazon BedrockのSigV4認証において、ANTHROPIC_AUTH_TOKEN 等でAuthorizationヘッダーが設定されていると403エラーになる問題を修正
英語原文を表示
Fixed Bedrock SigV4 authentication failing with 403 when ANTHROPIC_AUTH_TOKEN, apiKeyHelper, or ANTHROPIC_CUSTOM_HEADERS set an Authorization header

変更後

AWS Bedrockを利用した開発環境のセットアップにおける不透明な認証エラーが解消されます。

関連ドキュメント

v2.1.81(1件)

スクリプト実行用の --bare フラグを追加しました。フック、LSP、プラグイン同期、スキルディレクトリの走査をスキップし、自動メモリ機能も完全に無効化されます。
英語原文を表示
Added --bare flag for scripted -p calls — skips hooks, LSP, plugin sync, and skill directory walks; requires ANTHROPIC_API_KEY or an apiKeyHelper via --settings (OAuth and keychain auth disabled); auto-memory fully disabled

変更後

CI/CD パイプラインや自動化スクリプトにおいて、不要なオーバーヘッドを削減し、起動速度の向上と実行の安定性を確保できます。

関連ドキュメント

v2.1.77(1件)

API キー取得ヘルパーが 10 秒以上かかる場合に通知を表示し、メインループがブロックされないよう改善しました
英語原文を表示
Show a notice when apiKeyHelper takes longer than 10s, preventing it from blocking the main loop

関連ドキュメント

v1.0.37(1件)

v0.2.74(1件)