List Users

List of Workspace Users

Usage

prv workspace-user:list [options]

Aliases

You can also use these shorthand aliases:

• prv workspace-user:ls
• prv wsusr:list
• prv wsusr:ls

Options

Option	Description
-s, --search[=<value>]	Global keyword search for a partial string match
-i, --id[=<value>]	Filter results that partially match
--provider_id[=<value>]	Filter results that partially match
--name[=<value>]	Filter results that partially match
--handle[=<value>]	Filter results that partially match
--email[=<value>]	Filter results that partially match
--state[=<value>]	Show users with specific state (staged|active|expiring)
--deleted	Only show soft deleted (expired|deactivated) users
--created_before[=<value>]	Filter results created before a specific date
--created_after[=<value>]	Filter results created after a specific date
--updated_before[=<value>]	Filter results updated before a specific date
--updated_after[=<value>]	Filter results updated after a specific date
--expires_before[=<value>]	Filter results that will expire before a specific date
--expires_after[=<value>]	Filter results that will expire after a specific date
--expired_before[=<value>]	Filter results that expired before a specific date
--expired_after[=<value>]	Filter results that expired after a specific date
--deactivated_before[=<value>]	Filter results that were deactivated before a specific date
--deactivated_after[=<value>]	Filter results that were deactivated after a specific date
--deleted_before[=<value>]	Filter results that were deactivated or expired before a specific date
--deleted_after[=<value>]	Filter results that were deactivated or expired after a specific date
--json	(Debug) Show the raw JSON API response
--api	(Debug) Show the API endpoint and query string in the command header

Examples

List all active users

prv workspace-user:list --state=active

Search by name

prv workspace-user:list --search="John Smith"

Filter by email domain

prv workspace-user:list --email="@example.com"

Find users created this month

prv workspace-user:list --created_after=2024-01-01

Show expiring users

prv workspace-user:list --state=expiring

List deactivated users

prv workspace-user:list --deleted