--- title: Workspaces url: https://platform.claude.com/docs/en/api/java/organization/federation/rules/workspaces --- # Workspaces ## Add Federation Rule Workspace `FederationRuleWorkspace organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())` **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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=java). 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 params` - `Optional federationRuleId` (path parameter) ID of the federation rule. - `String workspaceId` Tagged ID of the workspace to enable this rule for. ### Returns - `class FederationRuleWorkspace` - `JsonValue type = "federation_rule_workspace"` - `LocalDateTime createdAt` When this workspace was enabled for the rule. format: date-time - `Optional createdByActorId` Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. - `String federationRuleId` Tagged ID of the federation rule. - `String workspaceId` Tagged ID of the workspace this rule is enabled for. - `Optional workspaceName` Workspace display name. Populated when listing; null in the enable response. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.federation.rules.FederationRuleWorkspace; import com.anthropic.models.organization.federation.rules.workspaces.WorkspaceAddParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceAddParams params = WorkspaceAddParams.builder() .federationRuleId("federation_rule_id") .workspaceId("workspace_id") .build(); FederationRuleWorkspace federationRuleWorkspace = client.organization().federation().rules().workspaces().add(params); } } ``` #### Response (200) ```json { "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" } ``` ## List Federation Rule Workspaces `WorkspaceListPage organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` **GET** `/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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=java). List workspaces where this federation rule is enabled. Returns all workspace enablements in a single response; the `limit` and `page` parameters are accepted but have no effect, and `next_page` is always `null`. Returns explicit per-workspace enablements only; for rules with `applies_to_all_workspaces` or a legacy single `workspace_id`, check those fields on the rule itself. ### Parameters - `WorkspaceListParams params` - `Optional federationRuleId` (path parameter) ID of the federation rule. - `Optional limit` (query parameter) Number of results per page. minimum: 1, maximum: 100 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page`. ### Returns - `class FederationRuleWorkspace` - `JsonValue type = "federation_rule_workspace"` - `LocalDateTime createdAt` When this workspace was enabled for the rule. format: date-time - `Optional createdByActorId` Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. - `String federationRuleId` Tagged ID of the federation rule. - `String workspaceId` Tagged ID of the workspace this rule is enabled for. - `Optional workspaceName` Workspace display name. Populated when listing; null in the enable response. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.federation.rules.workspaces.WorkspaceListPage; import com.anthropic.models.organization.federation.rules.workspaces.WorkspaceListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceListPage page = client.organization().federation().rules().workspaces().list("federation_rule_id"); } } ``` #### Response (200) ```json { "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" } ``` ## Remove Federation Rule Workspace `WorkspaceRemoveResponse organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())` **DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` **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](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=java). Disable a federation rule for a workspace. Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. ### Parameters - `WorkspaceRemoveParams params` - `String federationRuleId` (path parameter) ID of the federation rule. - `Optional workspaceId` (path parameter) ID of the workspace to disable for. ### Returns - `class WorkspaceRemoveResponse` - `JsonValue type = "federation_rule_workspace_deleted"` - `String federationRuleId` Tagged ID of the federation rule. - `String workspaceId` Tagged ID of the workspace named in the delete request. Removal is idempotent. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.federation.rules.workspaces.WorkspaceRemoveParams; import com.anthropic.models.organization.federation.rules.workspaces.WorkspaceRemoveResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceRemoveParams params = WorkspaceRemoveParams.builder() .federationRuleId("federation_rule_id") .workspaceId("workspace_id") .build(); WorkspaceRemoveResponse workspace = client.organization().federation().rules().workspaces().remove(params); } } ``` #### Response (200) ```json { "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace_deleted", "workspace_id": "workspace_id" } ```