Skip to content
Everruns Cloud is open in early access. Run agents without operating the platform.

Runtime accounts for consumers or services.

CommandWhat it does
virtual-users createCreate a new virtual user (org-scoped runtime account for a consumer or service).
virtual-users deleteArchive a virtual user (soft delete).
virtual-users destroyPermanently delete a virtual user.
virtual-users getGet a single virtual user by ID.
virtual-users listList virtual users by usage and search.
virtual-users updateUpdate a virtual user.

Create a new virtual user (org-scoped runtime account for a consumer or service).

Terminal window
everruns virtual-users create [OPTIONS] --name <name>
FlagDescription
--avatar-url <AVATAR_URL>Profile image URL.
--description <DESCRIPTION>Human-readable description.
--locale <LOCALE>Locale used for agent-facing defaults.
--name <NAME>Required. Human-readable name.
--timezone <TIMEZONE>IANA time zone used for agent-facing defaults.
--usage <USAGE>VirtualUser is a durable virtual principal. One of end_user, service.

Example:

Terminal window
# Create a service account for unattended agent runs
everruns virtual-users create --name ops-bot --usage service --description 'Runs the nightly triage' --reason 'Dedicated identity for nightly triage'

Archive a virtual user (soft delete). Can be restored.

Terminal window
everruns virtual-users delete [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Archive a virtual user that is no longer needed; it can be restored
everruns virtual-users delete identity_01h9 --reason 'Integration decommissioned'

Permanently delete a virtual user.

Terminal window
everruns virtual-users destroy [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Permanently remove a virtual user
everruns virtual-users destroy identity_01h9 --reason 'Integration decommissioned'

Get a single virtual user by ID.

Terminal window
everruns virtual-users get [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.

Example:

Terminal window
# Show a virtual user's profile and status
everruns virtual-users get identity_01h9

List virtual users by usage and search. Supports pagination (limit/offset) and include_archived.

Terminal window
everruns virtual-users list [OPTIONS]
FlagDescription
--include-archivedInclude archived runtime accounts.
--limit <LIMIT>Maximum results per page, capped at the platform pagination limit.
--offset <OFFSET>Zero-based page offset.
--search <SEARCH>Search runtime names and descriptions.
--usage <USAGE>

Example:

Terminal window
# Find service accounts by name
everruns virtual-users list --usage service --search ops

Update a virtual user. Only provided fields are changed.

Terminal window
everruns virtual-users update [OPTIONS] [ID]
FlagDescription
--id <ID>Prefixed public identifier.
--avatar-url <AVATAR_URL>Profile image URL.
--description <DESCRIPTION>Human-readable description.
--locale <LOCALE>Locale used for agent-facing defaults.
--name <NAME>Human-readable name.
--status <STATUS>
--timezone <TIMEZONE>IANA time zone used for agent-facing defaults.

Example:

Terminal window
# Change a virtual user's display name
everruns virtual-users update identity_01h9 --name triage-bot --reason 'Match the team naming'