組織 - Claude API Reference

取得目前組織

GET/v1/organizations/me

擷取與已驗證 API 金鑰相關聯之組織的資訊。

Models

BetaOrganization object{ type: "organization", id, name }

type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization

id: string

ID of the Organization.

formatuuid

name: string

Name of the Organization.

BetaOrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more

One of the following:

"admin"

"billing"

"claude_code_user"

"developer"

"managed"

"membership_admin"

"owner"

"primary_owner"

"user"

組織API 金鑰

擷取 API 金鑰（Admin API）

GET/v1/organizations/api_keys/{api_key_id}

依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰，專為程式化金鑰管理而設計，且絕不會回傳金鑰的祕密值。若要檢視或建立您自己的 API 金鑰，請前往 Claude Console 中的 API 金鑰。

更新 API 金鑰

POST/v1/organizations/api_keys/{api_key_id}

組織外部金鑰

建立外部金鑰

POST/v1/organizations/external_keys

建立由呼叫者組織所擁有的外部金鑰設定。

列出外部金鑰

GET/v1/organizations/external_keys

列出呼叫者組織中的外部金鑰設定。

取得外部金鑰

GET/v1/organizations/external_keys/{external_key_id}

依 ID 擷取呼叫者組織中的單一外部金鑰設定。

更新外部金鑰

POST/v1/organizations/external_keys/{external_key_id}

部分更新外部金鑰設定。省略的欄位保持不變。

刪除外部金鑰

DELETE/v1/organizations/external_keys/{external_key_id}

刪除外部金鑰設定。

驗證外部金鑰

POST/v1/organizations/external_keys/{external_key_id}/validate

針對客戶的 KMS 驗證外部金鑰設定。

組織聯合簽發者

建立聯合簽發者

POST/v1/organizations/federation_issuers

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合簽發者

GET/v1/organizations/federation_issuers

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得聯合簽發者

GET/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新聯合簽發者

POST/v1/organizations/federation_issuers/{federation_issuer_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存聯合簽發者

POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織聯合規則

建立聯合規則

POST/v1/organizations/federation_rules

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合規則

GET/v1/organizations/federation_rules

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得聯合規則

GET/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新聯合規則

POST/v1/organizations/federation_rules/{federation_rule_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存聯合規則

POST/v1/organizations/federation_rules/{federation_rule_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織聯合規則工作區

新增聯合規則工作區

POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出聯合規則工作區

GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

移除聯合規則工作區

DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織邀請

建立邀請

POST/v1/organizations/invites

透過電子郵件邀請使用者加入組織。

取得邀請

GET/v1/organizations/invites/{invite_id}

依 ID 擷取邀請。

刪除邀請

DELETE/v1/organizations/invites/{invite_id}

刪除待處理的邀請。

組織服務帳戶

建立服務帳戶

POST/v1/organizations/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出服務帳戶

GET/v1/organizations/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得服務帳戶

GET/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新服務帳戶

POST/v1/organizations/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

封存服務帳戶

POST/v1/organizations/service_accounts/{service_account_id}/archive

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織服務帳戶工作區

將工作區新增至服務帳戶

POST/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

列出服務帳戶的工作區

GET/v1/organizations/service_accounts/{service_account_id}/workspaces

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

從服務帳戶移除工作區

DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織使用者

取得使用者

GET/v1/organizations/users/{user_id}

依使用者 ID 擷取組織的成員。

更新使用者

POST/v1/organizations/users/{user_id}

更新成員的組織角色。

移除使用者

DELETE/v1/organizations/users/{user_id}

從組織中移除成員。

組織工作區

取得工作區

GET/v1/organizations/workspaces/{workspace_id}

更新工作區

POST/v1/organizations/workspaces/{workspace_id}

封存工作區

POST/v1/organizations/workspaces/{workspace_id}/archive

組織工作區速率限制

列出工作區速率限制

GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

組織工作區成員

列出工作區成員

GET/v1/organizations/workspaces/{workspace_id}/members

建立工作區成員

POST/v1/organizations/workspaces/{workspace_id}/members

取得工作區成員

GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}

更新工作區成員

POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}

刪除工作區成員

DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

組織工作區服務帳戶

列出服務帳戶工作區成員

GET/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

建立服務帳戶工作區成員

POST/v1/organizations/workspaces/{workspace_id}/service_accounts

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

取得服務帳戶工作區成員

GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

更新服務帳戶工作區成員

POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

刪除服務帳戶工作區成員

DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

需要具有 org:admin 範圍的 OAuth 存取權杖，可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得；不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。

組織速率限制

列出組織速率限制

GET/v1/organizations/rate_limits

列出您組織的 Messages API 速率限制。

組織合規設定

取得合規設定

GET/v1/organizations/compliance_settings

擷取您組織的合規設定。

更新合規設定

POST/v1/organizations/compliance_settings

更新您組織的合規設定。

組織使用量報告

取得 Messages 使用量報告

GET/v1/organizations/usage_report/messages

取得 Claude Code 使用量報告

GET/v1/organizations/usage_report/claude_code

擷取 Claude Code 使用者的每日彙總使用量指標。讓組織能夠分析開發人員生產力並建置自訂儀表板。

**已棄用。**此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

取得通道

Deprecated

GET/v1/organizations/tunnels/{tunnel_id}

已棄用。 此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

封存通道

Deprecated

POST/v1/organizations/tunnels/{tunnel_id}/archive

已棄用。 此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

顯示通道權杖

Deprecated

POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

**已棄用。**此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

輪替通道權杖

Deprecated

POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

**已棄用。**此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

組織MCP 通道通道憑證

建立通道憑證

Deprecated

POST/v1/organizations/tunnels/{tunnel_id}/certificates

已棄用。 此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

列出通道憑證

Deprecated

GET/v1/organizations/tunnels/{tunnel_id}/certificates

**已棄用。**此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

取得通道憑證

Deprecated

GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

已棄用。 此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF token。在遷移期間，現有整合可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。

封存通道憑證

Deprecated

POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

已棄用。 此 Admin API 端點已由 Claude API 上的 /v1/tunnels 取代，並將在遷移期結束後移除。新的整合應使用 /v1/tunnels，搭配 anthropic-beta: mcp-tunnels-2026-06-22 標頭以及帶有 workspace:manage_tunnels 範圍的 WIF 權杖。在遷移期內，現有整合仍可繼續使用 mcp-tunnels-2026-05-19 標頭與 org:manage_tunnels 範圍運作。