Skip to content
OpenShell

Workspaces

Create OpenShell workspaces, assign members, and understand platform and workspace roles.

An OpenShell workspace is an access and resource isolation boundary. Sandboxes, sandbox workload templates, providers, provider profiles, services, policies, and settings belong to a workspace and are not visible to members of other workspaces.

The CLI targets the default workspace unless you set --workspace or OPENSHELL_WORKSPACE. The logical OpenShell workspace described here is separate from the /sandbox filesystem directory inside a sandbox.

For Kubernetes namespace mapping and managed per-workspace namespaces, see Workspace on Kubernetes.

OpenShell combines an identity-provider role with a membership record for each workspace.

Role Assignment Access
Platform Admin The OIDC role configured as admin_role. Manages platform-scoped configuration and every workspace. Platform Admins bypass workspace membership checks.
Workspace Admin An admin membership stored by the gateway for one workspace. Manages providers, provider profiles, policies, settings, and members in that workspace.
Workspace User A user membership stored by the gateway for one workspace. Creates and uses sandboxes and services, reads providers, and uses provider attachments in that workspace.

OIDC users also need the role configured as user_role for ordinary workspace operations. The configured Platform Admin role satisfies this requirement. Membership does not grant access to another workspace, and a Workspace Admin cannot perform platform-scoped or cross-workspace operations.

When the gateway enables scope enforcement through scopes_claim, the token must also contain the scope required by the operation. Common scopes include workspace:read, workspace:write, sandbox:read, sandbox:write, provider:read, provider:write, config:read, and config:write. openshell:all satisfies every scope requirement. For OIDC and scope configuration, refer to Gateway Authentication.

The following table summarizes common operations.

Operation Platform Admin Workspace Admin Workspace User
Create or delete a workspace Any workspace No No
View a workspace or list workspaces All workspaces Assigned workspaces Assigned workspaces
List workspace members Any workspace Assigned workspace Assigned workspace
Add Workspace Users or remove members Any workspace Assigned workspace No
Assign the Workspace Admin role Any workspace No No
Create, use, or delete sandboxes and services Any workspace Assigned workspace Assigned workspace
Create or delete sandbox workload templates Any workspace Assigned workspace No
Read or list sandbox workload templates Any workspace Assigned workspace Assigned workspace
Create, update, or delete providers Any workspace Assigned workspace No
Change workspace policy or settings Any workspace Assigned workspace No
Manage platform profiles or global configuration Yes No No
List resources across workspaces Yes No No

Use the identity validated by the gateway when an administrator needs your membership subject.

Terminal window
openshell whoami
openshell whoami --output json

The subject field is the stable identity used in workspace membership records. Each user can run this command even when they do not belong to a workspace.

A Platform Admin creates workspaces and assigns the first Workspace Admin. The gateway creates the default workspace automatically, but it does not add OIDC users to that workspace automatically.

Create a workspace:

Terminal window
openshell workspace create --name team-ml

Ask the intended Workspace Admin to run openshell whoami, then add the reported subject:

Terminal window
openshell workspace member add \
--workspace team-ml \
--subject 'oidc-subject-for-admin' \
--role admin

The Workspace Admin can add Workspace Users:

Terminal window
openshell workspace member add \
--workspace team-ml \
--subject 'oidc-subject-for-user' \
--role user

Only a Platform Admin can assign the admin membership role. A Workspace Admin can add user members and remove members in their assigned workspace.

All members can inspect membership in their workspace. Workspace Admins and Platform Admins can remove members.

Terminal window
openshell workspace member list --workspace team-ml
openshell workspace member remove \
--workspace team-ml \
--subject 'oidc-subject-for-user'

Add --output json or --output yaml to list membership records for automation. Each record contains subject and a normalized role of admin, user, or unknown. Structured output is an envelope with members and next_page_token fields; pass the returned token to --page-token to continue. An empty result has an empty members collection.

To change a member’s role, remove the existing membership and add it again with the new role. A Platform Admin must perform any change to admin.

Attach labels when you create a workspace to track environment or team ownership. Repeat --label for each key-value pair.

Terminal window
openshell workspace create --name team-research --label env=dev --label team=ml

List workspaces that match every key-value pair in a comma-separated selector. Filtering only returns workspaces you are authorized to view.

Terminal window
openshell workspace list --label-selector env=dev,team=ml

Inspect a workspace to see its labels. Pass --output json or --output yaml to workspace create, workspace get, or workspace list for structured output in automation.

Terminal window
openshell workspace get team-research
openshell workspace get team-research --output json
openshell workspace list --label-selector env=dev --output json

API clients set CreateWorkspaceRequest.labels and filter with ListWorkspacesRequest.label_selector. Returned workspace labels are stored in metadata.labels. OpenShell does not provide a workspace update operation to change labels after creation.

Pass --workspace to scope a resource operation. The flag is global, so it can appear before or after the subcommand.

Terminal window
openshell sandbox list --workspace team-ml
openshell provider list --workspace team-ml
openshell sandbox create \
--workspace team-ml \
--name research \
--from registry.example.com/team/agent-tools:1.0 \
-- bash

Set a default for the current shell with OPENSHELL_WORKSPACE:

Terminal window
export OPENSHELL_WORKSPACE=team-ml
openshell sandbox list

When --workspace is omitted, the CLI intentionally selects the default workspace. An empty workspace name is invalid and never means either default or all workspaces.

Platform Admins can opt into cross-workspace list operations:

Terminal window
openshell sandbox list --all-workspaces
openshell provider list --all-workspaces
openshell service list --all-workspaces

Workspace-scoped public requests use the workspace_scope field with a WorkspaceSelector. Single-workspace requests select a non-empty canonical name, including the literal default. Only sandbox, sandbox template, provider, and service collection list requests also accept all_workspaces. The all-workspaces selection requires Platform Admin access. For services, choose either a sandbox name or --all-workspaces; the options are mutually exclusive.

Every sandbox-scoped RPC identifies the sandbox by its human-readable name and keeps workspace selection in a separate field:

{
"workspaceScope": { "workspace": "team-ml" },
"name": "agent"
}

Public requests do not accept canonical sandbox IDs as references. This is a breaking API change: regenerate protobuf clients and replace stored ID references with sandbox names before calling the public API. The four collection list RPCs use the request-level workspace_scope selector.

The Rust and Python SDKs expose separate all-workspaces list methods. The Go SDK passes AllWorkspaces: true in ListOptions to ListAll, and the TypeScript SDK uses a discriminated option type, so a caller cannot select a named workspace and all workspaces in one typed call. The TUI starts in the default workspace and sends that name explicitly. Its all-workspaces collection views send the selector marker instead.

Provider profiles and policy also have explicit --global operations. Those operations target platform scope and require Platform Admin access. A Workspace Admin should use --workspace for workspace-scoped profiles and configuration.

If openshell workspace list returns no rows, the authenticated subject has no workspace memberships. Run openshell whoami and send the subject value to a Platform Admin.

Workspace authorization errors include a copyable membership command. A non-member denial suggests --role user. If an operation requires Workspace Admin access, the denial suggests --role admin; only a Platform Admin can run that assignment successfully.

If the membership is correct but the request is still denied, inspect roles and scopes with openshell whoami --output json. Confirm that the token has the configured OIDC user role and, when scope enforcement is enabled, the scope required by the operation.

Only a Platform Admin can delete a workspace. The default workspace cannot be deleted.

Terminal window
openshell workspace delete team-ml

A custom workspace must not contain sandboxes, sandbox workload templates, providers, provider profiles, services, SSH sessions, settings, policies, draft policy chunks, or credential refresh state. Remove those resources before retrying deletion. OpenShell removes membership records as part of successful workspace deletion.

We are a Cloud Native Computing Foundation sandbox project.