Claude Platform Docs

Add Federation Rule Workspace

organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> FederationRuleWorkspace
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: str⁠Path parameter

ID of the federation rule.

workspace_id: str

Tagged ID of the workspace to enable this rule for.

Returns
class FederationRuleWorkspace: type: "federation_rule_workspace"; created_at; created_by_actor_id; ... # 3 more
type: Literal["federation_rule_workspace"]
defaultfederation_rule_workspace
created_at: datetime

When this workspace was enabled for the rule.

formatdate-time
created_by_actor_id: Optional[str]

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

federation_rule_id: str

Tagged ID of the federation rule.

workspace_id: str

Tagged ID of the workspace this rule is enabled for.

workspace_name: Optional[str]

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

Add Federation Rule Workspace
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
federation_rule_workspace = client.organization.federation.rules.workspaces.add(
    federation_rule_id="federation_rule_id",
    workspace_id="workspace_id",
)
print(federation_rule_workspace.created_by_actor_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"
}