Create Service Account Workspace Member

BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(, )

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.

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<String> workspaceId

ID of the workspace.

Optional<List<AnthropicBeta>> betas

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

String serviceAccountId

Tagged service account ID to add.

BetaNoBillingWorkspaceRole workspaceRole

Role to assign to the service account in this workspace.

Returns

class BetaServiceAccountWorkspaceMember:

Optional<String> createdByActorId

Tagged ID (user_.../svac_...) of the actor who created this membership.

Optional<Boolean> 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_...).

JsonValue type

String workspaceId

Tagged workspace ID (wrkspc_...).

BetaWorkspaceRole workspaceRole

Role of the service account in this workspace. Service accounts cannot hold the workspace_billing role.

One of the following:

WORKSPACE_ADMIN("workspace_admin")

WORKSPACE_BILLING("workspace_billing")

WORKSPACE_DEVELOPER("workspace_developer")

WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")

WORKSPACE_USER("workspace_user")

Create Service Account Workspace Member

package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.serviceaccounts.BetaServiceAccountWorkspaceMember;
import com.anthropic.models.beta.organization.workspaces.BetaNoBillingWorkspaceRole;
import com.anthropic.models.beta.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(BetaNoBillingWorkspaceRole.WORKSPACE_ADMIN)
            .build();
        BetaServiceAccountWorkspaceMember betaServiceAccountWorkspaceMember = client.beta().organization().workspaces().serviceAccounts().add(params);
    }
}

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

Returns Examples

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