everruns virtual-users
Applies toFramework (not available)Self-hostedEverruns Cloud
Runtime accounts for consumers or services.
| Command | What it does |
|---|---|
virtual-users create | Create a new virtual user (org-scoped runtime account for a consumer or service). |
virtual-users delete | Archive a virtual user (soft delete). |
virtual-users destroy | Permanently delete a virtual user. |
virtual-users get | Get a single virtual user by ID. |
virtual-users list | List virtual users by usage and search. |
virtual-users update | Update a virtual user. |
virtual-users create
Section titled “virtual-users create”Create a new virtual user (org-scoped runtime account for a consumer or service).
everruns virtual-users create [OPTIONS] --name <name>| Flag | Description |
|---|---|
--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:
# Create a service account for unattended agent runseverruns virtual-users create --name ops-bot --usage service --description 'Runs the nightly triage' --reason 'Dedicated identity for nightly triage'virtual-users delete
Section titled “virtual-users delete”Archive a virtual user (soft delete). Can be restored.
everruns virtual-users delete [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Archive a virtual user that is no longer needed; it can be restoredeverruns virtual-users delete identity_01h9 --reason 'Integration decommissioned'virtual-users destroy
Section titled “virtual-users destroy”Permanently delete a virtual user.
everruns virtual-users destroy [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Permanently remove a virtual usereverruns virtual-users destroy identity_01h9 --reason 'Integration decommissioned'virtual-users get
Section titled “virtual-users get”Get a single virtual user by ID.
everruns virtual-users get [OPTIONS] [ID]| Flag | Description |
|---|---|
--id <ID> | Prefixed public identifier. |
Example:
# Show a virtual user's profile and statuseverruns virtual-users get identity_01h9virtual-users list
Section titled “virtual-users list”List virtual users by usage and search. Supports pagination (limit/offset) and include_archived.
everruns virtual-users list [OPTIONS]| Flag | Description |
|---|---|
--include-archived | Include 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:
# Find service accounts by nameeverruns virtual-users list --usage service --search opsvirtual-users update
Section titled “virtual-users update”Update a virtual user. Only provided fields are changed.
everruns virtual-users update [OPTIONS] [ID]| Flag | Description |
|---|---|
--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:
# Change a virtual user's display nameeverruns virtual-users update identity_01h9 --name triage-bot --reason 'Match the team naming'