--- title: Workspaces url: https://platform.claude.com/docs/en/api/java/organization/service_accounts/workspaces --- # Workspaces ## Add Workspace To Service Account `ServiceAccountWorkspaceMember organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/service_accounts/{service_account_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). Add a service account to a workspace with the given `workspace_role`. Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed from the service-account side; both create the same membership. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected. ### Parameters - `WorkspaceAddParams params` - `Optional serviceAccountId` (path parameter) ID of the service account. - `String workspaceId` Tagged workspace ID to add the service account to. - `NoBillingWorkspaceRole workspaceRole` Role to assign to the service account in this workspace. ### Returns - `class ServiceAccountWorkspaceMember` - `JsonValue type = "service_account_workspace_member"` - `Optional createdByActorId` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `Optional implicit` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `String serviceAccountId` Tagged service account ID (`svac_...`). - `String workspaceId` Tagged workspace ID (`wrkspc_...`). - `WorkspaceRole workspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `WORKSPACE_ADMIN("workspace_admin")` - `WORKSPACE_BILLING("workspace_billing")` - `WORKSPACE_DEVELOPER("workspace_developer")` - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` - `WORKSPACE_USER("workspace_user")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.serviceaccounts.ServiceAccountWorkspaceMember; import com.anthropic.models.organization.serviceaccounts.workspaces.WorkspaceAddParams; import com.anthropic.models.organization.workspaces.NoBillingWorkspaceRole; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceAddParams params = WorkspaceAddParams.builder() .serviceAccountId("service_account_id") .workspaceId("workspace_id") .workspaceRole(NoBillingWorkspaceRole.WORKSPACE_ADMIN) .build(); ServiceAccountWorkspaceMember serviceAccountWorkspaceMember = client.organization().serviceAccounts().workspaces().add(params); } } ``` #### Response (200) ```json { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ``` ## List Workspaces For Service Account `WorkspaceListPage organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/service_accounts/{service_account_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 the workspaces a service account is a member of. Each entry includes the service account's `workspace_role` in that workspace. Use `limit` and the `next_page` cursor to paginate. When the service account has no explicit default-workspace membership, the implicit (`implicit: true`) membership is returned as the first entry on the first page; with `limit=1` the first page may return up to 2 entries (the implicit entry plus one explicit membership) so a pagination cursor can be derived. Memberships are returned only while the service account is active. Without a `page` cursor, an archived service account returns an empty list. A `page` cursor that does not match an active membership returns a 400 invalid-request error. A cursor stops matching when the membership is removed, the workspace is deleted, or the service account is archived. Restart pagination from the first page to recover. ### Parameters - `WorkspaceListParams params` - `Optional serviceAccountId` (path parameter) ID of the service account. - `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 ServiceAccountWorkspaceMember` - `JsonValue type = "service_account_workspace_member"` - `Optional createdByActorId` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `Optional implicit` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `String serviceAccountId` Tagged service account ID (`svac_...`). - `String workspaceId` Tagged workspace ID (`wrkspc_...`). - `WorkspaceRole workspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `WORKSPACE_ADMIN("workspace_admin")` - `WORKSPACE_BILLING("workspace_billing")` - `WORKSPACE_DEVELOPER("workspace_developer")` - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` - `WORKSPACE_USER("workspace_user")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.serviceaccounts.workspaces.WorkspaceListPage; import com.anthropic.models.organization.serviceaccounts.workspaces.WorkspaceListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceListPage page = client.organization().serviceAccounts().workspaces().list("service_account_id"); } } ``` #### Response (200) ```json { "data": [ { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ], "next_page": "next_page" } ``` ## Remove Workspace From Service Account `WorkspaceRemoveResponse organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())` **DELETE** `/v1/organizations/service_accounts/{service_account_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). Remove a service account from a workspace. Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, addressed from the service-account side. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400. ### Parameters - `WorkspaceRemoveParams params` - `String serviceAccountId` (path parameter) ID of the service account. - `Optional workspaceId` (path parameter) ID of the workspace. ### Returns - `class WorkspaceRemoveResponse` - `JsonValue type = "service_account_workspace_member_deleted"` - `String serviceAccountId` Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. - `String workspaceId` Tagged workspace ID (`wrkspc_...`) named in the delete request. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.serviceaccounts.workspaces.WorkspaceRemoveParams; import com.anthropic.models.organization.serviceaccounts.workspaces.WorkspaceRemoveResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceRemoveParams params = WorkspaceRemoveParams.builder() .serviceAccountId("service_account_id") .workspaceId("workspace_id") .build(); WorkspaceRemoveResponse workspace = client.organization().serviceAccounts().workspaces().remove(params); } } ``` #### Response (200) ```json { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } ```