Export Users

Export list of Directory Users to file or spreadsheet

Usage

prv directory-user:export [options]

Aliases

You can also use these shorthand aliases:

• prv drusr:export

Options

Option	Description
-f, --format[=<value>]	Output format (csv|json|yaml)
-s, --search[=<value>]	Global keyword search for a partial string match
--workspace_integration_id[=<value>]	Filter results for a specific source. Can be passed multiple times.
--manager_id[=<value>]	Filter results for users that report to a specific manager. Can be passed multiple times.
--is_manager	Filter results to only show users that are managers (have direct reports)
--is_not_manager	Filter 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)
-D, --deleted	Only show soft deleted (expired|deactivated) records
-S, --state[=<value>]	Only show records with specific state (staged|active|expiring)
--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
-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.
--api	(Debug) Show the API endpoint and query string in the command header

Examples

Export to CSV

prv directory-user:export --format=csv

Export to JSON

prv directory-user:export --format=json

Export to YAML

prv directory-user:export --format=yaml

Export filtered by manager

prv directory-user:export --format=csv --manager_id=drusr_01hq8xyzabc123def456ghi789

Export only managers

prv directory-user:export --format=csv --is_manager

Export active users only

prv directory-user:export --format=csv --state=active

Export with date filter

prv directory-user:export --format=json --created_after="2024-01-01"

Export with custom columns

prv directory-user:export --format=csv --column=manager --column=source