--- title: Workspaces url: https://platform.claude.com/docs/en/api/java/organization/workspaces --- # Workspaces ## List Workspaces `WorkspaceListPage organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces` List Workspaces ### Parameters - `WorkspaceListParams params` - `Optional afterId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `Optional beforeId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Optional includeArchived` (query parameter) Whether to include Workspaces that have been archived in the response - `Optional includeDefault` (query parameter) Whether to include the organization's default Workspace in the response - `Optional limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 ### Returns - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.WorkspaceListPage; import com.anthropic.models.organization.workspaces.WorkspaceListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceListPage page = client.organization().workspaces().list(); } } ``` #### Response (200) ```json { "data": [ { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Create Workspace `Workspace organization().workspaces().create(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces` Create Workspace ### Parameters - `WorkspaceCreateParams params` - `String name` Name of the Workspace. minLength: 1, maxLength: 255 - `Optional dataResidency` Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. - `Optional displayColor` Hex color code representing the Workspace in the Anthropic Console. maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `Optional tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Returns - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.Workspace; import com.anthropic.models.organization.workspaces.WorkspaceCreateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); WorkspaceCreateParams params = WorkspaceCreateParams.builder() .name("x") .build(); Workspace workspace = client.organization().workspaces().create(params); } } ``` #### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ## Get Workspace `Workspace organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}` Get Workspace ### Parameters - `WorkspaceRetrieveParams params` - `Optional workspaceId` (path parameter) ID of the Workspace. ### Returns - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.Workspace; import com.anthropic.models.organization.workspaces.WorkspaceRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); Workspace workspace = client.organization().workspaces().retrieve("workspace_id"); } } ``` #### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ## Update Workspace `Workspace organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}` Update Workspace ### Parameters - `WorkspaceUpdateParams params` - `Optional workspaceId` (path parameter) - `Optional dataResidency` Data residency configuration for the workspace. - `Optional displayColor` Hex color code representing the Workspace in the Anthropic Console. maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `Optional name` Name of the Workspace. minLength: 1, maxLength: 255 - `Optional tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Returns - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.Workspace; import com.anthropic.models.organization.workspaces.WorkspaceUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); Workspace workspace = client.organization().workspaces().update("workspace_id"); } } ``` #### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ## Archive Workspace `Workspace organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}/archive` Archive Workspace ### Parameters - `WorkspaceArchiveParams params` - `Optional workspaceId` (path parameter) ### Returns - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.Workspace; import com.anthropic.models.organization.workspaces.WorkspaceArchiveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); Workspace workspace = client.organization().workspaces().archive("workspace_id"); } } ``` #### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ## Domain types ### Allowed Inference Geo - `enum AllowedInferenceGeo` - `GLOBAL("global")` - `US("us")` ### Data Residency - `class DataResidency` - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. ### Data Residency Create Config - `class DataResidencyCreateConfig` - `Optional allowedInferenceGeos` Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `Optional defaultInferenceGeo` Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. - `GLOBAL("global")` - `US("us")` - `Optional workspaceGeo` Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. ### Data Residency Update Config - `class DataResidencyUpdateConfig` - `Optional allowedInferenceGeos` Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `Optional defaultInferenceGeo` Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. - `GLOBAL("global")` - `US("us")` ### No Billing Workspace Role - `enum NoBillingWorkspaceRole` - `WORKSPACE_ADMIN("workspace_admin")` - `WORKSPACE_DEVELOPER("workspace_developer")` - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` - `WORKSPACE_USER("workspace_user")` ### Workspace - `class Workspace` - `JsonValue type = "workspace"` Object type. For Workspaces, this is always `"workspace"`. - `String id` ID of the Workspace. - `Optional archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `String compartmentId` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `LocalDateTime createdAt` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `DataResidency dataResidency` Data residency configuration. - `AllowedInferenceGeos allowedInferenceGeos` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `List` - `GLOBAL("global")` - `US("us")` - `JsonValue` - `DefaultInferenceGeo defaultInferenceGeo` Default inference geo applied when requests omit the parameter. - `GLOBAL("global")` - `US("us")` - `WorkspaceGeo workspaceGeo` Geographic region for workspace data storage. Immutable after creation. - `String displayColor` Hex color code representing the Workspace in the Anthropic Console. - `Optional externalKeyId` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `String name` Name of the Workspace. - `Tags tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. ### Workspace Member - `class WorkspaceMember` - `JsonValue type = "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. - `WorkspaceRole workspaceRole` Role of the Workspace Member. - `WORKSPACE_ADMIN("workspace_admin")` - `WORKSPACE_BILLING("workspace_billing")` - `WORKSPACE_DEVELOPER("workspace_developer")` - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` - `WORKSPACE_USER("workspace_user")` ### Workspace Role - `enum WorkspaceRole` - `WORKSPACE_ADMIN("workspace_admin")` - `WORKSPACE_BILLING("workspace_billing")` - `WORKSPACE_DEVELOPER("workspace_developer")` - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")` - `WORKSPACE_USER("workspace_user")` ## Workspaces › Rate Limits ### List Workspace Rate Limits `RateLimitListPage organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` List a workspace's rate limits. By default, returns only the groups and limiter types that have a workspace-level override. With `include_inherited=true`, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's `source` says which it is. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries. #### Parameters - `RateLimitListParams params` - `Optional workspaceId` (path parameter) The ID of the workspace. - `Optional groupType` (query parameter) Filter by group type. - `BATCH("batch")` - `FILES("files")` - `MODEL_GROUP("model_group")` - `SKILLS("skills")` - `TOKEN_COUNT("token_count")` - `WEB_SEARCH("web_search")` - `Optional includeInherited` (query parameter) Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override. - `Optional limit` (query parameter) Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`. minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page`. #### Returns - `class WorkspaceRateLimit` - `JsonValue type = "workspace_rate_limit"` Object type. Always `workspace_rate_limit` for workspace rate-limit entries. - `Group group` The rate-limit group this entry's limits apply to. Its `type` equals `group_type`. - `class OrganizationRateLimitModelGroup` - `JsonValue type = "model_group"` Always `model_group`: a family of models. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `String displayName` Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change. - `class OrganizationRateLimitBatchGroup` - `JsonValue type = "batch"` Always `batch`: the Message Batches API. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `class OrganizationRateLimitTokenCountGroup` - `JsonValue type = "token_count"` Always `token_count`: the Token Count API. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `class OrganizationRateLimitFilesGroup` - `JsonValue type = "files"` Always `files`: the Files API. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `class OrganizationRateLimitSkillsGroup` - `JsonValue type = "skills"` Always `skills`: the Skills API. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `class OrganizationRateLimitWebSearchGroup` - `JsonValue type = "web_search"` Always `web_search`: the Messages API web search tool. - `String id` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `List limits` The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With `include_inherited` set to `true`, the limiter types the workspace inherits from the organization are listed too, each marked by `source`. - `String type` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `Optional orgLimit` The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. - `Source source` Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`. - `class WorkspaceRateLimitWorkspaceSource` - `JsonValue type = "workspace"` Always `workspace`: a workspace-level override is stored. - `class WorkspaceRateLimitOrganizationSource` - `JsonValue type = "organization"` Always `organization`: no workspace-level override is stored, so the organization's value applies. - `long value` The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value. - `Optional> models` Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `String rateLimitId` The `id` of the organization's RateLimit entry this entry applies to. - `String workspaceId` ID of the Workspace this entry applies to. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.ratelimits.RateLimitListPage; import com.anthropic.models.organization.workspaces.ratelimits.RateLimitListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); RateLimitListPage page = client.organization().workspaces().rateLimits().list("workspace_id"); } } ``` ##### Response (200) ```json { "data": [ { "group": { "id": "id", "display_name": "display_name", "type": "model_group" }, "group_type": "batch", "limits": [ { "org_limit": 0, "source": { "type": "workspace" }, "type": "type", "value": 0 } ], "models": [ "string" ], "rate_limit_id": "rate_limit_id", "type": "workspace_rate_limit", "workspace_id": "workspace_id" } ], "next_page": "next_page" } ``` ## Workspaces › Members ### List Workspace Members `MemberListPage organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}/members` List Workspace Members #### Parameters - `MemberListParams params` - `Optional workspaceId` (path parameter) ID of the Workspace. - `Optional afterId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `Optional beforeId` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Optional limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 #### Returns - `class WorkspaceMember` - `JsonValue type = "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. - `WorkspaceRole workspaceRole` Role of the Workspace Member. - `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.workspaces.members.MemberListPage; import com.anthropic.models.organization.workspaces.members.MemberListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MemberListPage page = client.organization().workspaces().members().list("workspace_id"); } } ``` ##### Response (200) ```json { "data": [ { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Create Workspace Member `WorkspaceMember organization().workspaces().members().add(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}/members` Create Workspace Member #### Parameters - `MemberAddParams params` - `Optional workspaceId` (path parameter) ID of the Workspace. - `String userId` ID of the User. - `NoBillingWorkspaceRole workspaceRole` Role of the new Workspace Member. Cannot be `workspace_billing`. #### Returns - `class WorkspaceMember` - `JsonValue type = "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. - `WorkspaceRole workspaceRole` Role of the Workspace Member. - `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.workspaces.NoBillingWorkspaceRole; import com.anthropic.models.organization.workspaces.WorkspaceMember; import com.anthropic.models.organization.workspaces.members.MemberAddParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MemberAddParams params = MemberAddParams.builder() .workspaceId("workspace_id") .userId("user_01WCz1FkmYMm4gnmykNKUu3Q") .workspaceRole(NoBillingWorkspaceRole.WORKSPACE_ADMIN) .build(); WorkspaceMember workspaceMember = client.organization().workspaces().members().add(params); } } ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Get Workspace Member `WorkspaceMember organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Get Workspace Member #### Parameters - `MemberRetrieveParams params` - `String workspaceId` (path parameter) ID of the Workspace. - `Optional userId` (path parameter) ID of the User. #### Returns - `class WorkspaceMember` - `JsonValue type = "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. - `WorkspaceRole workspaceRole` Role of the Workspace Member. - `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.workspaces.WorkspaceMember; import com.anthropic.models.organization.workspaces.members.MemberRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MemberRetrieveParams params = MemberRetrieveParams.builder() .workspaceId("workspace_id") .userId("user_id") .build(); WorkspaceMember workspaceMember = client.organization().workspaces().members().retrieve(params); } } ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Update Workspace Member `WorkspaceMember organization().workspaces().members().update(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Update Workspace Member #### Parameters - `MemberUpdateParams params` - `String workspaceId` (path parameter) ID of the Workspace. - `Optional userId` (path parameter) ID of the User. - `WorkspaceRole workspaceRole` New workspace role for the User. #### Returns - `class WorkspaceMember` - `JsonValue type = "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. - `WorkspaceRole workspaceRole` Role of the Workspace Member. - `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.workspaces.WorkspaceMember; import com.anthropic.models.organization.workspaces.WorkspaceRole; import com.anthropic.models.organization.workspaces.members.MemberUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MemberUpdateParams params = MemberUpdateParams.builder() .workspaceId("workspace_id") .userId("user_id") .workspaceRole(WorkspaceRole.WORKSPACE_ADMIN) .build(); WorkspaceMember workspaceMember = client.organization().workspaces().members().update(params); } } ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Delete Workspace Member `MemberRemoveResponse organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())` **DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Delete Workspace Member #### Parameters - `MemberRemoveParams params` - `String workspaceId` (path parameter) ID of the Workspace. - `Optional userId` (path parameter) ID of the User. #### Returns - `class MemberRemoveResponse` - `JsonValue type = "workspace_member_deleted"` Deleted object type. For Workspace Members, this is always `"workspace_member_deleted"`. - `String userId` ID of the User. - `String workspaceId` ID of the Workspace. #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.organization.workspaces.members.MemberRemoveParams; import com.anthropic.models.organization.workspaces.members.MemberRemoveResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); MemberRemoveParams params = MemberRemoveParams.builder() .workspaceId("workspace_id") .userId("user_id") .build(); MemberRemoveResponse member = client.organization().workspaces().members().remove(params); } } ``` ##### Response (200) ```json { "type": "workspace_member_deleted", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ## Workspaces › Service Accounts ### List Service Account Workspace Members `ServiceAccountListPage organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` **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 service accounts that are members of a workspace. Each entry includes the service account's `workspace_role`. Use `limit` and the `next_page` cursor to paginate. Archived workspaces return 400; use `GET /service_accounts/{id}/workspaces` to audit memberships of an archived workspace. The implicit default-workspace membership is not included in this list. Memberships of archived service accounts are omitted from the results. #### Parameters - `ServiceAccountListParams params` - `Optional workspaceId` (path parameter) ID of the workspace. - `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.workspaces.serviceaccounts.ServiceAccountListPage; import com.anthropic.models.organization.workspaces.serviceaccounts.ServiceAccountListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ServiceAccountListPage page = client.organization().workspaces().serviceAccounts().list("workspace_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" } ``` ### Create Service Account Workspace Member `ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` **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`. The role determines what the service account can do in the workspace and which workspace-scoped permissions it can be granted when authenticating through federation. Every service account is already an implicit `workspace_user` member of the default workspace; adding it explicitly assigns a chosen role. 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 - `ServiceAccountAddParams params` - `Optional workspaceId` (path parameter) ID of the workspace. - `String serviceAccountId` Tagged service account ID to add. - `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.workspaces.NoBillingWorkspaceRole; import com.anthropic.models.organization.workspaces.serviceaccounts.ServiceAccountAddParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ServiceAccountAddParams params = ServiceAccountAddParams.builder() .workspaceId("workspace_id") .serviceAccountId("service_account_id") .workspaceRole(NoBillingWorkspaceRole.WORKSPACE_ADMIN) .build(); ServiceAccountWorkspaceMember serviceAccountWorkspaceMember = client.organization().workspaces().serviceAccounts().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" } ``` ### Get Service Account Workspace Member `ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())` **GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_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). Retrieve a service account's membership in a workspace. Returns the membership record, including the service account's `workspace_role` in this workspace. Archived workspaces return 400. For the default workspace, returns the implicit (`implicit: true`) membership when no explicit membership exists; an explicitly added membership is returned with its assigned role. An archived service account returns 404. #### Parameters - `ServiceAccountRetrieveParams params` - `String workspaceId` (path parameter) ID of the workspace. - `Optional serviceAccountId` (path parameter) ID of the service account. #### 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.workspaces.serviceaccounts.ServiceAccountRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ServiceAccountRetrieveParams params = ServiceAccountRetrieveParams.builder() .workspaceId("workspace_id") .serviceAccountId("service_account_id") .build(); ServiceAccountWorkspaceMember serviceAccountWorkspaceMember = client.organization().workspaces().serviceAccounts().retrieve(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" } ``` ### Update Service Account Workspace Member `ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_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). Change a service account's role in a workspace. The new `workspace_role` replaces the current one. Only explicit memberships can be updated; to set a role on the implicit default-workspace membership, add the service account explicitly with `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces return 400. Archived service accounts cannot be updated and are rejected. #### Parameters - `ServiceAccountUpdateParams params` - `String workspaceId` (path parameter) ID of the workspace. - `Optional serviceAccountId` (path parameter) ID of the service account. - `NoBillingWorkspaceRole workspaceRole` New role for 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.workspaces.NoBillingWorkspaceRole; import com.anthropic.models.organization.workspaces.serviceaccounts.ServiceAccountUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ServiceAccountUpdateParams params = ServiceAccountUpdateParams.builder() .workspaceId("workspace_id") .serviceAccountId("service_account_id") .workspaceRole(NoBillingWorkspaceRole.WORKSPACE_ADMIN) .build(); ServiceAccountWorkspaceMember serviceAccountWorkspaceMember = client.organization().workspaces().serviceAccounts().update(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" } ``` ### Delete Service Account Workspace Member `ServiceAccountRemoveResponse organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())` **DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_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. 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 - `ServiceAccountRemoveParams params` - `String workspaceId` (path parameter) ID of the workspace. - `Optional serviceAccountId` (path parameter) ID of the service account. #### Returns - `class ServiceAccountRemoveResponse` - `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.workspaces.serviceaccounts.ServiceAccountRemoveParams; import com.anthropic.models.organization.workspaces.serviceaccounts.ServiceAccountRemoveResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); ServiceAccountRemoveParams params = ServiceAccountRemoveParams.builder() .workspaceId("workspace_id") .serviceAccountId("service_account_id") .build(); ServiceAccountRemoveResponse serviceAccount = client.organization().workspaces().serviceAccounts().remove(params); } } ``` ##### Response (200) ```json { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } ```