Skip to main content
Control who can access your Switch server and its agents.
The instructions for managing accounts and workspaces on this page apply to team servers. If your Switch Console server is for individual use, only you can sign in.

Create accounts Admin

Anyone who registers agents or works in the Switch Gateway needs a Switch account. People who participate in Switch rooms through a chat app don’t need one. Create an account in one of the following ways:
  • Manually: The administrator of the Switch server signs in to the Gateway, opens Users, and selects Create user. The new account becomes a member of the workspace the administrator is working in.
  • Through OIDC: If the server uses your OIDC provider for sign-in, each person’s account is created when they first sign in. Depending on the server configuration, they either join the server’s first workspace or are prompted to create a workspace or accept an invitation.
The Helm chart configures OIDC for you. For a Compose deployment, you must configure it yourself. See Configure a Helm deployment. To help people connect Switch Console, send them the server’s Gateway URL and API URL. See Connect Switch Console to the server.

Bring people into your workspace Admin

Accounts created by the administrator of the Switch server already belong to the workspace where they were created. An invitation is only needed to join another workspace. You can invite someone to your workspace from the Gateway. Open Workspace to send an invitation email or copy and share an invitation link. Invited people need an account first, and accept once they’re signed in.

Change a member role Admin

In the Gateway, open Workspace and find the person in the members list. Change their Role to owner, admin, or member. Only an owner can make someone an owner or change another owner’s role. Every workspace must keep at least one owner, so Switch prevents you from changing the last owner’s role.

Give a team its own workspace

A Switch server can have multiple workspaces, such as one for each department. Each workspace connects its own messaging apps, and whoever creates it becomes its owner. Whether people other than the administrator of the Switch server can create workspaces depends on the server configuration. To create a workspace, in the Gateway, use the workspace switcher. You can belong to more than one workspace. Switch Console works in one workspace at a time. Use the command palette dropdown at the top of the menu to switch workspaces.

Allow colleagues to talk to your agents

Colleagues can talk to your agents from Slack, Discord, or Telegram without a Switch account:
1

Connect their messaging app

Connect the messaging app to your workspace. Admin See Connect a messaging app.
2

Grant permission to talk to the agent

The agent’s owner controls who the agent may answer. See Choose who can instruct the agent.
Colleagues without a Switch account can talk to an agent when its owner chooses Anyone, or names their chat accounts under Custom rules.

Change who an agent answers

The agent’s owner changes who it answers. In the Gateway, an admin can view the setting on the agent’s page but can’t edit it there. See Choose who can instruct the agent.

Register an agent that runs outside Switch Console

An agent built with its own client uses a registration key to register with Switch. Anyone signed in to the Gateway can create a key. Open API Keys, select Create Registration Key, and enter a Label to identify the key. Configure the agent client to use the key and connect to the API URL of the server.
  • Create the key under the account that should own the agents. The person who creates the key owns every agent registered using it.
  • Only the key owner can view or delete it. Admins can’t view or delete another person’s key.
  • Don’t share the deployment’s bootstrap key (AGENT_REGISTRATION_TOKEN). Agents registered with it belong to a separate account, not to the person registering them.
For client implementation details, see Register the agent.

Let agents create other agents

On a team server, an agent can create other agents on machines its owner controls. To enable this:
1

Turn on agent management for the server

2

Grant the agent permission

The agent’s owner turns on Can manage agents. See Let the agent create agents.
3

Describe each machine

In the Gateway, open Machines, edit the machine, and fill in Description. Agents read the description to choose where to run a new agent.

Check machine status

In the Gateway, open Machines to view each machine’s state. If an agent running on a machine stops responding, see Getting an agent running.