Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.provisionr.io/llms.txt

Use this file to discover all available pages before exploring further.

Usage

prv directory-user:list [options]

Aliases

You can also use these shorthand aliases:
  • prv directory-user:ls
  • prv drusr:list
  • prv drusr:ls

Options

OptionDescription
-s, --search[=<value>]Global keyword search for a partial string match
--workspace_integration_id[=<value>]Filter results for a specific integration. Can be passed multiple times.
--manager_id[=<value>]Filter results for users that report to a specific manager. Can be passed multiple times.
--is_managerFilter results to only show users that are managers (have direct reports)
--is_not_managerFilter results to only show users that are not managers (no direct reports)
--first_name[=<value>]Filter results that exactly match (no partials)
--last_name[=<value>]Filter results that exactly match (no partials)
--full_name[=<value>]Filter results that exactly match (no partials)
--full_name_search[=<value>]Filter results that partially match (fuzzy search)
-e, --email[=<value>]Filter results that exactly match (no partials)
--email_search[=<value>]Filter results that partially match (fuzzy search)
--username[=<value>]Filter results that exactly match (no partials)
--badge_id[=<value>]Filter results that exactly match (no partials)
--badge_id_search[=<value>]Filter results that partially match (fuzzy search)
--employee_id[=<value>]Filter results that exactly match (no partials)
--employee_id_search[=<value>]Filter results that partially match (fuzzy search)
--employee_id_alt[=<value>]Filter results that exactly match (no partials)
--employee_id_alt_search[=<value>]Filter results that partially match (fuzzy search)
--org_array_search[=<value>]Filter org department, title, etc that partially match (fuzzy search)
--metadata_array_search[=<value>]Filter custom business logic that partially match (fuzzy search)
-D, --deletedOnly show soft deleted (expired|deactivated) records
-S, --state[=<value>]Only show records with specific state (staged|active|expiring)
--created_before[=<value>]Filter results created (imported) before a specific date
--created_after[=<value>]Filter results created (imported) after a specific date
--provisioned_before[=<value>]Filter results that were provisioned before a specific date
--provisioned_after[=<value>]Filter results that were provisioned 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
-C, --column[=<value>]Show a specific hidden column. Can be passed multiple times.
-H, --hide[=<value>]Hide a specific visible column. Can be passed multiple times.
--json(Debug) Show the raw JSON API response
--api(Debug) Show the API endpoint and query string in the command header

Examples

List all users

prv directory-user:list

Search by keyword

prv directory-user:list --search=john

Filter by email

prv directory-user:list --email=user@example.com

Filter by manager

prv directory-user:list --manager_user_id=drusr_01hq8xyzabc123def456ghi789

Show only managers

prv directory-user:list --is_manager

Filter by state

prv directory-user:list --state=active

Show deleted users

prv directory-user:list --deleted

Filter by date range

prv directory-user:list --created_after="2024-01-01" --created_before="2024-12-31"

Search by employee ID

prv directory-user:list --employee_id_search=EMP123