Add Federation Rule Workspace

BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)

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

WorkspaceAddParams parameters

required string federationRuleID

Path param: ID of the federation rule.

required string workspaceID

Body param: Tagged ID of the workspace to enable this rule for.

IReadOnlyList<AnthropicBeta> betas

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

MessageBatches2024_09_24("message-batches-2024-09-24")

PromptCaching2024_07_31("prompt-caching-2024-07-31")

ComputerUse2024_10_22("computer-use-2024-10-22")

ComputerUse2025_01_24("computer-use-2025-01-24")

Pdfs2024_09_25("pdfs-2024-09-25")

TokenCounting2024_11_01("token-counting-2024-11-01")

TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")

Output128k2025_02_19("output-128k-2025-02-19")

FilesApi2025_04_14("files-api-2025-04-14")

McpClient2025_04_04("mcp-client-2025-04-04")

McpClient2025_11_20("mcp-client-2025-11-20")

DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")

InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")

CodeExecution2025_05_22("code-execution-2025-05-22")

ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")

Context1m2025_08_07("context-1m-2025-08-07")

ContextManagement2025_06_27("context-management-2025-06-27")

ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")

Skills2025_10_02("skills-2025-10-02")

FastMode2026_02_01("fast-mode-2026-02-01")

Output300k2026_03_24("output-300k-2026-03-24")

UserProfiles2026_03_24("user-profiles-2026-03-24")

UserProfiles2026_08_18("user-profiles-2026-08-18")

UserProfiles2026_09_04("user-profiles-2026-09-04")

AdvisorTool2026_03_01("advisor-tool-2026-03-01")

ManagedAgents2026_04_01("managed-agents-2026-04-01")

CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")

Dreaming2026_04_21("dreaming-2026-04-21")

ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")

ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")

ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")

FallbackCredit2026_06_01("fallback-credit-2026-06-01")

FallbackCredit2026_07_01("fallback-credit-2026-07-01")

AgentMemory2026_07_22("agent-memory-2026-07-22")

MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")

Compact2026_01_12("compact-2026-01-12")

ComputerUse2025_11_24("computer-use-2025-11-24")

McpTunnels2026_06_22("mcp-tunnels-2026-06-22")

StructuredOutputs2025_11_13("structured-outputs-2025-11-13")

TaskBudgets2026_03_13("task-budgets-2026-03-13")

ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")

CEUserManagement2026_07_13("ce-user-management-2026-07-13")

MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")

ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")

MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")

Compact2026_09_04("compact-2026-09-04")

Returns

class BetaFederationRuleWorkspace { Type = "federation_rule_workspace"; CreatedAt; CreatedByActorID; /* 3 more */ }

JsonElement Type = "federation_rule_workspace"

required DateTimeOffset CreatedAt

When this workspace was enabled for the rule.

formatdate-time

required string? CreatedByActorID

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

required string FederationRuleID

Tagged ID of the federation rule.

required string WorkspaceID

Tagged ID of the workspace this rule is enabled for.

required string? WorkspaceName

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

Add Federation Rule Workspace

WorkspaceAddParams parameters = new()
{
    FederationRuleID = "federation_rule_id",
    WorkspaceID = "workspace_id",
};

var betaFederationRuleWorkspace = await client.Beta.Organization.Federation.Rules.Workspaces.Add(parameters);

Console.WriteLine(betaFederationRuleWorkspace);

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

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