Claude Platform Docs

更新工作區

BetaWorkspace beta().organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}

更新工作區

Parameters
WorkspaceUpdateParams params
Optional<String> workspaceId⁠Path parameter
Optional<BetaDataResidencyUpdateConfig> dataResidency

Data residency configuration for the workspace.

Optional<String> displayColor

Hex color code representing the Workspace in the Anthropic Console.

maxLength7
pattern^#[0-9A-Fa-f]{6}$
Optional<String> 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<String> name

Name of the Workspace.

minLength1
maxLength255
Optional<Tags> tags

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

Returns
class BetaWorkspace { type = "workspace"; id; archivedAt; /* 7 more */ }
更新工作區
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.workspaces.BetaWorkspace;
import com.anthropic.models.beta.organization.workspaces.WorkspaceUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        BetaWorkspace betaWorkspace = client.beta().organization().workspaces().update("workspace_id");
    }
}
Returns Examples
Response 200
{
  "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"
}