Skip to main content
Version: v5.6.1

opschain users list

Included from Basic tier

Lists the user accounts visible to you from GET /api/users: superusers see everyone; other users see themselves. Rows render as a table (USERNAME PROVIDER GROUPS EMAIL ID), - standing in for an absent group list or email; with nothing visible it prints no users visible. -o json|yaml emits the JSON:API resources verbatim.

Beyond the shared --filter, the command takes no flags of its own. A server target is required (--server <url>, OPSCHAIN_SERVER or the active context); in local mode it fails with users need a server target — pass --server <url> or 'opschain context use <name>' (local mode has no users) (exit 2).

Flags​

FlagMeaning
--filter <column>[!]=<value>Keep only rows matching the term (repeatable; terms AND). Columns are the printed table headers lowercased (spaces/dashes fold to _); * wildcards match the whole cell case-insensitively, != negates, commas mean any-of. Applied client-side. Grammar: opschain docs cli.

Exit codes​

CodeMeaning
0Users listed.
1The server request failed.
2Usage error (no server target).

Examples​

opschain users list
opschain users list -o yaml

See also​

  • opschain docs cli/users-show — one account in full, including superuser standing.