工作区

列出工作区

$client->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?bool includeDefault, ?int limit): Page<Workspace>

GET/v1/organizations/workspaces

$client->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array<string,string> tags, ?string userProfileID): Workspace

POST/v1/organizations/workspaces

获取工作区

$client->organization->workspaces->retrieve(string workspaceID): Workspace

GET/v1/organizations/workspaces/{workspace_id}

更新工作区

$client->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array<string,string> tags, ?string userProfileID): Workspace

POST/v1/organizations/workspaces/{workspace_id}

归档工作区

$client->organization->workspaces->archive(string workspaceID): Workspace

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

Models

enum AllowedInferenceGeo

One of the following:

"global"

"us"

class DataResidency { $allowedInferenceGeos; $defaultInferenceGeo; $workspaceGeo; }

AllowedInferenceGeos allowedInferenceGeos

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

DefaultInferenceGeo defaultInferenceGeo

Default inference geo applied when requests omit the parameter.

WorkspaceGeo workspaceGeo

Geographic region for workspace data storage. Immutable after creation.

class DataResidencyCreateConfig { $allowedInferenceGeos; $defaultInferenceGeo; $workspaceGeo; }

?AllowedInferenceGeos allowedInferenceGeos

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.

?DefaultInferenceGeo defaultInferenceGeo

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".

?WorkspaceGeo workspaceGeo

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

class DataResidencyUpdateConfig { $allowedInferenceGeos; $defaultInferenceGeo; }

?AllowedInferenceGeos allowedInferenceGeos

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

?DefaultInferenceGeo defaultInferenceGeo

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

enum NoBillingWorkspaceRole

One of the following:

"workspace_admin"

"workspace_developer"

"workspace_restricted_developer"

"workspace_user"

class Workspace { $type = 'workspace'; $id; $archivedAt; /* 8 more */ }

class WorkspaceMember { $type = 'workspace_member'; $userID; $workspaceID; $workspaceRole; }

"workspace_member" type

Object type.

For Workspace Members, this is always "workspace_member".

string userID

ID of the User.

string workspaceID

ID of the Workspace.

WorkspaceRole workspaceRole

Role of the Workspace Member.

enum WorkspaceRole

One of the following:

"workspace_admin"

"workspace_billing"

"workspace_developer"

"workspace_restricted_developer"

"workspace_user"

工作区速率限制

列出工作区速率限制

$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>

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

列出工作区的速率限制（rate limit）。

设置工作区速率限制

$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimit

POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

为工作区中的某个速率限制组设置或清除速率限制覆盖值。

工作区成员

列出工作区成员

$client->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page<WorkspaceMember>

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

创建工作区成员

$client->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMember

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

获取工作区成员

$client->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMember

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

更新工作区成员

$client->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMember

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

删除工作区成员

$client->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponse

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

工作区服务账号

列出服务账号工作区成员

$client->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>

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

需要具有 org:admin 作用域的 OAuth 访问令牌，可通过 ant auth login --scope org:admin 或工作负载身份联合规则获取；不接受 Admin API 密钥。请参阅使用 Admin API 管理 WIF。

创建服务账号工作区成员

$client->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember

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

获取服务账号工作区成员

$client->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID): ServiceAccountWorkspaceMember

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

更新服务账号工作区成员

$client->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember

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

删除服务账号工作区成员

$client->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID): ServiceAccountRemoveResponse

DELETE/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。

工作区

Models

工作区速率限制

工作区成员

工作区服务账号

工作区速率限制

工作区成员

工作区服务账号