ボールトによる認証
セッション作成時にユーザーごとの認証情報を登録します。
ボールト(vault)と認証情報(credential)は、サードパーティサービスの認証情報を一度登録しておき、セッション作成時にIDで参照できるようにする認証プリミティブです。これにより、独自のシークレットストアを運用したり、呼び出しごとにトークンを送信したり、エージェントがどのエンドユーザーの代理として動作したかを見失ったりする必要がなくなります。
ボールトの参照はセッションごとのパラメータであるため、プロダクトは agent リソースの粒度で、ユーザーは session リソースの粒度で管理できます。
ボールトを作成する
ボールトは、エンドユーザーに関連付けられた credentials のコレクションです。display_name を付け、必要に応じて metadata でタグ付けすることで、自社のユーザーレコードに対応付けられるようにします。
vault = client.beta.vaults.create(
display_name="Alice",
metadata={"external_user_id": "usr_abc123"},
)
print(vault.id) # "vlt_01ABC..."レスポンスは完全なボールトレコードです。
{
"type": "vault",
"id": "vlt_01ABC...",
"display_name": "Alice",
"metadata": { "external_user_id": "usr_abc123" },
"created_at": "2026-03-18T10:00:00Z",
"updated_at": "2026-03-18T10:00:00Z",
"archived_at": null
}認証情報を追加する
2つの認証情報カテゴリがサポートされています。
- MCP認証情報(
mcp_oauth、static_bearer):各認証情報はmcp_server_urlをキーとします。セッション実行時にエージェントがそのURLのサーバーに接続すると、トークンが自動的に注入されます。 - 環境変数(
environment_variable):各認証情報はsecret_name(環境変数名)をキーとし、サンドボックス内には不透明なプレースホルダーとして保存されます。エージェントがアウトバウンドリクエストを開始すると、不透明なプレースホルダーはエグレス時に実際のシークレットに置き換えられます。エージェントがシークレットの値を目にすることはありません。CLI、SDK、直接のAPI呼び出しなど、環境変数を通じて認証するあらゆるサービスにこれを使用してください。
指定する実際の認証情報の値(token、access_token、refresh_token、client_secret、secret_value)は、機密性の高い書き込み専用フィールドとして扱われ、APIレスポンスで返されることはありません。
MCPサーバーがOAuth 2.0を使用する場合は mcp_oauth を使用します。refresh ブロックを指定すると、アクセストークンの有効期限が切れた際にAnthropicが代わりにリフレッシュを行います。
refresh.token_endpoint_auth.type フィールドは、リフレッシュ呼び出しの認証方法を示します。
none:パブリッククライアントclient_secret_basic:クライアントシークレットによるHTTP Basic認証client_secret_post:POSTボディ内のクライアントシークレット
credential = client.beta.vaults.credentials.create(
vault_id=vault.id,
display_name="Alice's Slack",
auth={
"type": "mcp_oauth",
"mcp_server_url": "https://mcp.slack.com/mcp",
"access_token": "xoxp-...",
"expires_at": "2099-12-31T23:59:59Z",
"refresh": {
"token_endpoint": "https://slack.com/api/oauth.v2.user.access",
"client_id": "1234567890.0987654321",
"scope": "channels:read chat:write",
"refresh_token": "xoxe-1-...",
"token_endpoint_auth": {"type": "client_secret_post", "client_secret": "abc123..."},
},
},
)refresh.token_endpoint には、リフレッシュトークンを発行したOAuthフローのトークンエンドポイントを設定してください。AnthropicはすべてのリフレッシュリクエストをそのURLに送信し、このフィールドは認証情報の作成後に変更できないためです。
MCPサーバーが固定のベアラートークン(APIキー、パーソナルアクセストークンなど)を受け付ける場合は static_bearer を使用します。リフレッシュフローは不要です。
bearer_credential = client.beta.vaults.credentials.create(
vault_id=vault.id,
display_name="Linear API key",
auth={
"type": "static_bearer",
"mcp_server_url": "https://mcp.linear.app/mcp",
"token": "lin_api_your_linear_key",
},
)CLI、SDK、直接のAPI呼び出しなど、環境変数を通じて外部サービスに認証するには environment_variable を使用します。環境変数の認証情報は、アウトバウンドリクエストでシークレットの値をそのまま送信するクライアントで機能するため、設定する前にこのタブにあるクライアントの適格基準を確認してください。
networking.allowed_hosts 配列は、シークレットの置換対象となるアウトバウンドホストを制御します。特定のリストを指定する場合は "type": "limited" を、呼び出し元が事前に列挙できないドメインに到達する場合は "type": "unrestricted" を使用します。
セキュリティ上の理由からドメインを制限することを強く推奨します。これにより、キーが許可されていないホストと共有されることを防げます。
オプションの injection_location フィールドは、シークレットが置換される場所のスコープを指定します。完全なセマンティクスは例の後に説明します。
env_credential = client.beta.vaults.credentials.create(
vault_id=vault.id,
display_name="Notion API key for sandbox",
auth={
"type": "environment_variable",
"secret_name": "NOTION_API_KEY",
"secret_value": "ntn_your-secret-here",
"networking": {
"type": "limited",
"allowed_hosts": ["api.notion.com"],
},
"injection_location": {"header": True},
},
)
if env_credential.auth.type == "environment_variable":
location = env_credential.auth.injection_location
print(f"header: {location.header}, body: {location.body}") # header: True, body: Falseリクエストペイロードはエージェントが扱っているコンテンツから組み立てられることが多いため、リクエストボディはより広い露出面となります。ほとんどのサービスはリクエストヘッダーからAPIキーを読み取るため、header のみを有効にするのがより限定的な設定です。これにより、その認証情報の置換はリクエストヘッダーの値に限定されます。
認証情報の injection_location は、アウトバウンドリクエストのどの部分にシークレットが置換されるかを制御します。これは networking と同階層にあるオプションのオブジェクトで、header(リクエストヘッダー)と body(リクエストボディ)の2つのブール値フィールドを持ちます。injection_location は networking.allowed_hosts とは独立しています。allowed_hosts はシークレットがどのホストに対して置換されるかのスコープを指定し、injection_location はリクエストのどの部分に置換されるかのスコープを指定します。
injection_location は作成時と更新時で動作が異なります。
| 操作 | injection_location の動作 |
|---|---|
| 認証情報の作成 | オブジェクトを指定した場合、その中で省略したフィールドはデフォルトで false になります。{"header": true} はヘッダーのみの認証情報を作成します。オブジェクト全体を省略すると、両方の場所が有効になります。 |