Claude Platform Docs

Add Federation Rule Workspace

$ ant beta:organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Enable a federation rule for a workspace.

Idempotent; re-enabling returns the existing enablement. The rule and workspace must both belong to your organization. Membership of the rule's target service account in this workspace is not checked at enablement: token exchange into this workspace is rejected unless the target is a member (it is implicitly a member of the default workspace). Archived rules are rejected with 400. OAuth callers may only manage rules whose oauth_scope is workspace:developer or workspace:inference; other scopes require a Console session.

Parameters
--federation-rule-id: string⁠Path parameter

ID of the federation rule.

--workspace-id: string

Tagged ID of the workspace to enable this rule for.

--beta: optional array of AnthropicBeta⁠Header parameter

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

One of the following:
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"output-128k-2025-02-19"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
"admin-user-sign-out-2026-10-08"
"message-threads-2026-08-12"
"analytics-usage-cost-2026-08-24"
"experimental-claude-tag-2026-10-21"
"user-profiles-billing-2026-10-01"
"message-batches-2024-09-24"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"prompt-caching-2024-07-31"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"pdfs-2024-09-25"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-counting-2024-11-01"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-efficient-tools-2025-02-19"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"files-api-2025-04-14"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/files#migrate-from-files-api-2025-04-14
"extended-cache-ttl-2025-04-11"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"skills-2025-10-02"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/skills-guide#migrate-from-skills-2025-10-02
"cache-diagnosis-2026-04-07"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"ce-user-management-2026-07-13"⁠Deprecated
This value is no longer needed. Remove it from your requests.
Returns
beta_federation_rule_workspace: object{ type: "federation_rule_workspace", created_at, created_by_actor_id, 3 more }
type: "federation_rule_workspace"
created_at: string

When this workspace was enabled for the rule.

formatdate-time
created_by_actor_id: string

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.

workspace_id: string

Tagged ID of the workspace this rule is enabled for.

workspace_name: string

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

Errors

Any method can also return the general HTTP errors.

Each code below is the value of error.details.error_code in the response body.

error code sandbox_egress_restrictedHTTP status 403

The request came from a Claude sandbox with restricted network access, which is not allowed to make this change. Send it from outside the sandbox, or from a sandbox with unrestricted network access.

Add Federation Rule Workspace
ant beta:organization:federation:rules:workspaces add \
  --federation-rule-id federation_rule_id \
  --workspace-id workspace_id
Returns Examples
Response 200
{
  "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"
}