Claude Platform Docs

列出聯合規則工作區

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

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

列出已啟用此聯合規則的工作區。

在單一回應中傳回所有工作區啟用項目;limitpage 參數 會被接受但沒有作用,且 next_page 一律為 null。僅傳回明確的 個別工作區啟用項目;對於具有 applies_to_all_workspaces 或舊版單一 workspace_id 的規則,請檢查規則本身的這些欄位。

Path parameters
federation_rule_id: string

ID of the federation rule.

Query parameters
limit: optional number

Number of results per page.

default20
maximum100
minimum1
page: optional string

Opaque cursor from a previous response's next_page.

Headers
"anthropic-beta": optional array of string

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

Returns
data: array of object{ created_at, created_by_actor_id, federation_rule_id, 3 more }
created_at: string

When this workspace was enabled for the rule.

formatdate-time
created_by_actor_id: string or null

Tagged ID (user_... or svac_...) of the actor that enabled this workspace for the rule, if known.

federation_rule_id: string

Tagged ID of the federation rule.

type: "federation_rule_workspace"
defaultfederation_rule_workspace
workspace_id: string

Tagged ID of the workspace this rule is enabled for.

workspace_name: string or null

Workspace display name. Populated when listing; null in the enable response.

next_page: string or null

Opaque cursor for the next page; null when there are no more results.

列出聯合規則工作區
cURL
curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
Returns Examples
Response 200
{
  "data": [
    {
      "created_at": "2024-10-30T23:58:27.427722Z",
      "created_by_actor_id": "created_by_actor_id",
      "federation_rule_id": "federation_rule_id",
      "type": "federation_rule_workspace",
      "workspace_id": "workspace_id",
      "workspace_name": "workspace_name"
    }
  ],
  "next_page": "next_page"
}