Claude Platform Docs

組織

取得目前組織
OrganizationInfo Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

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

Models
class OrganizationInfo { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum OrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

組織API 金鑰

列出 API 金鑰
ApiKeyListPage Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
擷取 API 金鑰（Admin API）
ApiKey Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

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

更新 API 金鑰
ApiKey Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

組織外部金鑰

建立外部金鑰
ExternalKey Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

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

列出外部金鑰
ExternalKeyListPage Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

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

取得外部金鑰
ExternalKey Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

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

更新外部金鑰
ExternalKey Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

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

刪除外部金鑰
ExternalKeyDeleteResponse Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

刪除外部金鑰設定。

驗證外部金鑰
ExternalKeyValidateResponse Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

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

組織聯合簽發者

建立聯合簽發者
FederationIssuer Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

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

列出聯合簽發者
IssuerListPage Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

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

取得聯合簽發者
FederationIssuer Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

更新聯合簽發者
FederationIssuer Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

封存聯合簽發者
FederationIssuer Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

組織聯合規則

建立聯合規則
FederationRule Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

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

列出聯合規則
RuleListPage Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

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

取得聯合規則
FederationRule Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

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

更新聯合規則
FederationRule Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

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

封存聯合規則
FederationRule Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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

組織聯合規則工作區

新增聯合規則工作區
FederationRuleWorkspace Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

列出聯合規則工作區
WorkspaceListPage Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

移除聯合規則工作區
WorkspaceRemoveResponse Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

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

組織邀請

建立邀請
OrganizationInvite Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

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

列出邀請
InviteListPage Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

列出組織的邀請。

取得邀請
OrganizationInvite Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

依 ID 擷取邀請。

刪除邀請
InviteDeleteResponse Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

刪除待處理的邀請。

組織服務帳戶

建立服務帳戶
ServiceAccount Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

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

列出服務帳戶
ServiceAccountListPage Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

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

取得服務帳戶
ServiceAccount Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

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

更新服務帳戶
ServiceAccount Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

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

封存服務帳戶
ServiceAccount Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

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

組織服務帳戶工作區

將工作區新增至服務帳戶
ServiceAccountWorkspaceMember Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

列出服務帳戶的工作區
WorkspaceListPage Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

從服務帳戶移除工作區
WorkspaceRemoveResponse Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

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

組織使用者

列出使用者
UserListPage Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

列出組織的成員。

取得使用者
OrganizationUser Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

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

更新使用者
OrganizationUser Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

更新成員的組織角色。

移除使用者
UserRemoveResponse Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

從組織中移除成員。

組織工作區

列出工作區
WorkspaceListPage Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
建立工作區
Workspace Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
取得工作區
Workspace Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
更新工作區
Workspace Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
封存工作區
Workspace Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

組織工作區速率限制

列出工作區速率限制
RateLimitListPage Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作區的速率限制。

設定工作區速率限制
WorkspaceRateLimit Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

為工作區中的單一速率限制群組設定或清除速率限制覆寫。

組織工作區成員

列出工作區成員
MemberListPage Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
建立工作區成員
WorkspaceMember Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
取得工作區成員
WorkspaceMember Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作區成員
WorkspaceMember Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
刪除工作區成員
MemberRemoveResponse Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

組織工作區服務帳戶

列出服務帳戶工作區成員
ServiceAccountListPage Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

建立服務帳戶工作區成員
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

取得服務帳戶工作區成員
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

更新服務帳戶工作區成員
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

刪除服務帳戶工作區成員
ServiceAccountRemoveResponse Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
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。

組織速率限制

列出組織速率限制
RateLimitListPage Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

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

組織合規設定

取得合規設定
OrganizationComplianceSettings Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

擷取您組織的合規設定。

更新合規設定
OrganizationComplianceSettings Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.