Claude Platform Docs

工作區

列出工作區
organization.workspaces.list(**kwargs) -> Page<Workspace>
GET/v1/organizations/workspaces
建立工作區
organization.workspaces.create(**kwargs) -> Workspace
POST/v1/organizations/workspaces
取得工作區
organization.workspaces.retrieve(workspace_id) -> Workspace
GET/v1/organizations/workspaces/{workspace_id}
更新工作區
organization.workspaces.update(workspace_id, **kwargs) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}
封存工作區
organization.workspaces.archive(workspace_id) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
type AllowedInferenceGeo = :global | :us
One of the following:
:global
:us
class DataResidency { allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: Array[AllowedInferenceGeo] | :unrestricted

Permitted inference geo values. 'unrestricted' means all geos are allowed.

One of the following:
Geos = Array[AllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :global | :us

Default inference geo applied when requests omit the parameter.

One of the following:
:global
:us
workspace_geo: :us

Geographic region for workspace data storage. Immutable after creation.

class DataResidencyCreateConfig { allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: Array[AllowedInferenceGeo] | :unrestricted

Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = Array[AllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :global | :us

Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
:global
:us
workspace_geo: :us

Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

class DataResidencyUpdateConfig { allowed_inference_geos, default_inference_geo }
allowed_inference_geos: Array[AllowedInferenceGeo] | :unrestricted

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = Array[AllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :global | :us

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
:global
:us
type NoBillingWorkspaceRole = :workspace_admin | :workspace_developer | :workspace_restricted_developer | :workspace_user
One of the following:
:workspace_admin
:workspace_developer
:workspace_restricted_developer
:workspace_user
class Workspace { type: :workspace, id, archived_at, 7 more }
class WorkspaceMember { type: :workspace_member, user_id, workspace_id, workspace_role }
type: :workspace_member

Object type.

For Workspace Members, this is always "workspace_member".

user_id: String

ID of the User.

workspace_id: String

ID of the Workspace.

workspace_role: WorkspaceRole

Role of the Workspace Member.

One of the following:
:workspace_admin
:workspace_billing
:workspace_developer
:workspace_restricted_developer
:workspace_user
type WorkspaceRole = :workspace_admin | :workspace_billing | :workspace_developer | 2 more
One of the following:
:workspace_admin
:workspace_billing
:workspace_developer
:workspace_restricted_developer
:workspace_user

工作區速率限制

列出工作區速率限制
organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作區的速率限制。

工作區成員

列出工作區成員
organization.workspaces.members.list(workspace_id, **kwargs) -> Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
建立工作區成員
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
取得工作區成員
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作區成員
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
刪除工作區成員
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

工作區服務帳戶

列出服務帳戶工作區成員
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> PageCursor<ServiceAccountWorkspaceMember>
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。

建立服務帳戶工作區成員
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
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。

取得服務帳戶工作區成員
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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。

更新服務帳戶工作區成員
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
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。

刪除服務帳戶工作區成員
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
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。