settings.json

apiKeyHelper

型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.274(1件)

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

変更前

apiKeyHelper スクリプトが失敗したとき、エラーバナーは「詳細は /status を確認せよ」と指示するが、実際に /status を開いても apiKeyHelper の失敗内容は表示されず、ユーザーはバナーの指示に従っても失敗の詳細を確認できなかった。

変更後

/status コマンドを実行しても、apiKeyHelper スクリプトの失敗内容が Authentication パネルに表示されず、エラーバナーの案内どおりに /status で失敗を確認しようとしても失敗の詳細を確認できなかった。

ユーザーへの恩恵

apiKeyHelper の失敗時にエラーバナーの案内どおり /status を開くだけで、失敗の詳細をその場で確認できるようになる。

関連ドキュメント

v2.1.266(1件)

Fixed
Settings
LLM ゲートウェイおよびプロキシ構成に影響する v2.1.265 のリグレッションを修正した。未ドキュメントの環境変数 CLAUDE_CODE_USE_GATEWAY は、以前は ANTHROPIC_BASE_URL と ANTHROPIC_AUTH_TOKEN の両方が設定されている場合にしか無視されなかったが、v2.1.265 では単独で Cloud gateway サインインを強制するようになり、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.265 で、未ドキュメントの環境変数 CLAUDE_CODE_USE_GATEWAY がANTHROPIC_BASE_URL と ANTHROPIC_AUTH_TOKEN の両方がなくても単独で Cloud gateway サインインを強制するようになった。API キー、apiKeyHelper、カスタム認証ヘッダーを使う構成ではすべてのリクエストが Not signed in to the Cloud gateway エラーで失敗した。

変更後

CLAUDE_CODE_USE_GATEWAY だけを設定した場合は無視されるようになり、Cloud gateway サインインを強制しない。API キー、apiKeyHelper、カスタム認証ヘッダーと組み合わせた構成も以前通り動作する。

ユーザーへの恩恵

LLM ゲートウェイやプロキシ環境のユーザーは構成変更なしでリクエストが再び成功するようになる。

関連ドキュメント

v2.1.248(1件)

Fixed
Settings
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

変更前

apiKeyHelper が唯一の認証情報である場合、ゲートウェイモデル検出が実行されず、モデルリストが取得できませんでした。これにより、利用可能なモデルが表示されませんでした。

変更後

apiKeyHelper が唯一の認証情報である場合でも、ゲートウェイモデル検出が正常に実行されるようになりました。

ユーザーへの恩恵

利用可能なモデルが正しく表示され、モデル選択が容易になります。

関連ドキュメント

v2.1.246(2件)

Fixed
Settings
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

変更前

apiKeyHelper が短命の JWT を返す場合、アイドル後の最初のプロンプトで期限切れのキャッシュトークンが原因で可視的な API エラーが発生していました。

変更後

期限切れのキャッシュトークンは送信前に更新され、認証エラーも静かに再試行されるようになりました。

ユーザーへの恩恵

認証エラーによる作業の中断が減り、ユーザーエクスペリエンスが向上します。

関連ドキュメント

Improved
Authentication
ワークロード 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

変更前

ワークロード ID フェデレーションセッションや起動時の apiKeyHelper 実行中のイベントなど、一部の使用量テレメトリが正しく組織に帰属していませんでした。

変更後

ワークロード ID フェデレーションセッション、起動時の apiKeyHelper 実行中のイベント、およびアイドル中にログイントークンが期限切れになった後の使用量テレメトリを、組織に正しく帰属させるように改善しました。

ユーザーへの恩恵

使用量データが正確に組織単位で追跡・分析できるようになり、コスト管理や利用状況の把握が正確になります。

関連ドキュメント

v2.1.208(1件)

Fixed
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 キーを取得する外部スクリプトが失敗しても、CLI が何度もサイレントリトライを繰り返した後に最終的に「401 Unauthorized」とだけ表示され、原因の特定が難しかった。

変更後

リトライ回数が削減され、スクリプトが出力した具体的なエラーメッセージが早期にユーザーに提示されるようになった。これにより、設定ミスや認証の有効期限切れにすぐ気づける。

ユーザーへの恩恵

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

関連ドキュメント

v2.1.141(1件)

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

変更前

共有設定(managed-settings)に記載されたapiKeyHelperやトークンが、本来それらを使用すべきでない環境(デスクトップアプリ等)でも適用されてしまうことがありました。

変更後

各実行環境に応じた認証情報の優先順位と継承ルールが厳密化され、不適切なクレデンシャルの混入が防止されます。

ユーザーへの恩恵

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

関連ドキュメント

v2.1.139(1件)

Changed
Permissions
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

変更前

Claude.aiログインとAPIキー(Console)の設定が混在している場合、一部の機能がどちらの権限で動作しているか曖昧になることがありました。

変更後

明示的にAPIキー( Console認証等)が設定されている場合は、それに基づく動作に限定され、意図しない課金や動作の混乱を防ぎます。

ユーザーへの恩恵

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

関連ドキュメント

v2.1.101(1件)

Fixed
Settings
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

変更前

Bedrock環境で利用する際、無関係な認証用環境変数が残っていると、AWS側の認証と干渉して接続に失敗することがありました。

変更後

Bedrock固有の署名付きヘッダーの生成が他の認証設定と干渉しないよう改善されました。

ユーザーへの恩恵

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

関連ドキュメント

v2.1.81(1件)

Added
HooksMemoryPluginsSettingsSkills
スクリプト実行用の --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

変更前

非インタラクティブモード(-p)でスクリプトを実行する際も、通常のセッションと同様にフックの実行やプラグインの同期、メモリの読み込みが行われていました。

変更後

--bare フラグを使用することで、純粋にモデルの推論のみを高速に実行できるようになります。このモードでは OAuth 認証等がバイパスされるため、API キーの設定が必須となります。

ユーザーへの恩恵

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

関連ドキュメント

v2.1.77(1件)

Changed
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件)

Added
Added support for refreshing dynamically generated API keys (via apiKeyHelper), with a 5 minute TTL

関連ドキュメント