Command Usage - Provisionr

Overview

Command	Purpose
`prv`	See a summary of all namespaces, resources, and actions.
`prv list`	See a comprehensive list of commands you can run.
`prv menu`	Easily navigate commands with a UI menu experience.
`prv {namespace}-{resource}:{action}`	Run a command. You will be prompted for any option/parameters you do not provide.
`prv {namespace}-{resource}:{action} --help`	Show all options for a command. This is similar to a manpage.
`prv {namespace}-{resource}:{action} --{option}={value}`	Use `--` for each option/parameter that you want to provide.
`prv {namespace}-{resource}:{action} -{x}={value}`	Use `-` for each shorthand option/parameter that you want to provide.
`prv {namespace}-{resource}:{action} --id {idprefix}_01hq8xyzabc123def456ghi789`	Get a record by ID using option.
`prv {namespace}-{resource}:{action} -i {idprefix}_01hq8xyzabc123def456ghi789`	Get a record by ID using shorthand option.
`prv {abbrev}:{action}`	Run a command using the abbreviated resource name. Options work the same way. You will be prompted for any option/parameters you do not provide.

Summary of Commands

Run the prv command to see a summary of commands.

prv

If you don’t want to use or remember commands, you can use prv menu for an arrow navigation menu experience.

prv menu

Resource Actions

Action	Command Syntax
Dashboard	`prv {resource}:dashboard`
List of Records	`prv {resource}:list`
Details of Specific Record	`prv {resource}:describe`
Create a Record	`prv {resource}:create`
Activate a Staged (or Expiring) Record	`prv {resource}:activate`
Change a Record	`prv {resource}:update`
Schedule Expiration for Record	`prv {resource}:deprecate`
Deactivate/Delete a Record	`prv {resource}:deactivate`
Export Records to File	`prv {resource}:export`

Resource Commands

Resource	Command Syntax	Shorthand Syntax
Audit Log	`prv audit-log:{action}`	`prv wslog:{action}`
CLI Settings	`prv cli-settings:{action}`	`prv cli:{action}`
Directory Attribute	`prv directory-attribute:{action}`	`prv dratr:{action}`
Directory Dimension	`prv directory-dimension:{action}`	`prv drdim:{action}`
Directory Identity	`prv directory-identity:{action}`	`prv dridt:{action}`
Directory Manager	`prv directory-manager:{action}`	`prv drmgr:{action}`
Directory User	`prv directory-user:{action}`	`prv drusr:{action}`
Google Integration	`prv google-integration:{action}`	`prv gwitg:{action}`
Google Integration Credential	`prv google-credential:{action}`	`prv gwcrd:{action}`
Google Workspace Group	`prv google-workspace-group:{action}`	`prv gwgrp:{action}`
Okta App	`prv okta-app:{action}`	`prv okapp:{action}`
Okta Group	`prv okta-group:{action}`	`prv okgrp:{action}`
Policy Condition	`prv policy-condition:{action}`	`prv pocon:{action}`
Policy Resource	`prv policy-resource:{action}`	`prv posrc:{action}`
Policy Rule	`prv policy-rule:{action}`	`prv porul:{action}`
Policy Ruleset	`prv policy-ruleset:{action}`	`prv poset:{action}`
Policy User	`prv policy-user:{action}`	`prv pousr:{action}`
Support Ticket	`prv hq-support:{action}`	`prv hqtix:{action}`
Workspace Abbreviation	`prv workspace-abbreviation:{action}`	`prv wsabv:{action}`
Workspace Device	`prv workspace-device:{action}`	`prv wsdev:{action}`
Workspace Permission	`prv workspace-permission:{action}`	`prv wsprm:{action}`
Workspace Role	`prv workspace-role:{action}`	`prv wsrol:{action}`
Workspace Role Permission	`prv workspace-role-permission:{action}`	`prv wsrap:{action}`
Workspace Role Service	`prv workspace-role-service:{action}`	`prv wsras:{action}`
Workspace Role User	`prv workspace-role-user:{action}`	`prv wsrau:{action}`
Workspace Service	`prv workspace-service:{action}`	`prv wssvc:{action}`
Workspace User	`prv workspace-user:{action}`	`prv wsusr:{action}`

Roadmap Resources (Coming Soon)

The following resources are planned but not yet available. They appear in the CLI for discoverability, but currently only respond with a “Coming Soon” message. Command and shorthand names may change before release.

Resource	Command Syntax	Shorthand Syntax
GitLab Group	`prv gitlab-group:{action}`	`prv glgrp:{action}`
GitLab Project	`prv gitlab-project:{action}`	`prv glprj:{action}`
Google Cloud Billing Account	`prv google-cloud-billing-account:{action}`	`prv gcbil:{action}`
Google Cloud Folder	`prv google-cloud-folder:{action}`	`prv gcfol:{action}`
Google Cloud Organization	`prv google-cloud-org:{action}`	`prv gcorg:{action}`
Google Cloud Project	`prv google-cloud-project:{action}`	`prv gcprj:{action}`
Google Drive Document	`prv google-drive-doc:{action}`	`prv gddoc:{action}`
Google Drive Folder	`prv google-drive-folder:{action}`	`prv gdfol:{action}`
Google Drive Slide Deck	`prv google-drive-deck:{action}`	`prv gddck:{action}`
Google Drive Spreadsheet	`prv google-drive-sheet:{action}`	`prv gdsht:{action}`
Google Drive Uploaded File	`prv google-drive-file:{action}`	`prv gdfil:{action}`
Google Identity Group	`prv google-identity-group:{action}`	`prv gigrp:{action}`
Google Workspace Shared Drive	`prv google-workspace-drive:{action}`	`prv gwdrv:{action}`
Slack Group	`prv slack-group:{action}`	`prv slgrp:{action}`
Slack Private Channel	`prv slack-private-channel:{action}`	`prv slprv:{action}`
Slack Public Channel	`prv slack-public-channel:{action}`	`prv slpub:{action}`

Interactive Prompts

With most industry CLI clients, you have to pass the argument or option with the CLI command. With Provisionr, we check for any options you’ve already provided, then prompt you for anything else you have not specified. This allows you to simply run the command without any options. You do not need to take a few moments to study the available options. As an added benefit, most options are presented as a searchable select menu to reduce the number of keystrokes needed, or the multiple terminal sessions to lookup records and copy IDs, etc.

Interactive Menus

You can navigate menus using the arrows keys on your keyboard and press ENTER/RETURN to make a selection. Some menus support undo functionality and you can press Ctrl+U to go back and change your selection. To exit a menu at any time, press Ctrl+C.

Command Options

Help Command

Use the --help option on any command to see details about it’s usage.

prv directory-dimension:create --help

Description:
  Create a Custom Directory Dimension

Usage:
  directory-dimension:create [options]
  directory-dimension:new
  drdim:create
  drdim:new

Options:
      --name[=NAME]                              The name of the dimension. This will be used to create the handle
      --handle[=HANDLE]                          The handle of the dimension. The name will be used to create the handle if not set
  -e, --expires_after_days[=EXPIRES_AFTER_DAYS]  The number of days that attributes and associated users will expire after deprecated
  -A, --activate                                 Set status to active. If not set, record will be staged.

  -h, --help                                     Display help for the given command. When no command is given display help for the summary command
      --silent                                   Do not output any message
  -q, --quiet                                    Only errors are displayed. All other output is suppressed
  -V, --version                                  Display this application version
      --ansi|--no-ansi                           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction                           Do not ask any interactive question
      --env[=ENV]                                The environment the command should run under
  -v|vv|vvv, --verbose                           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Equals vs Spaces

The --help command and documentation shows an equal sign between an option and the value (ex. --option=value). You can also use a space instead of the equal sign (--option value).

# Both formats are allowed

# prv directory-dimension:create --{option} {value}
prv directory-dimension:create --name Team

# prv directory-dimension:create --{option}={value}
prv directory-dimension:create --name=Team

Quote Wrapped Strings

Any strings with a space must be wrapped in double quotes. Single quotes or backticks may work depending on your OS but are not tested or supported.

# Both formats are allowed
prv directory-dimension:create --name "Sales Region"
prv directory-dimension:create --name="Sales Region"

# Without quotes, the Region is a separate command argument and not part of the string
prv directory-dimension:create --name Sales Region
prv directory-dimension:create --name=Sales Region

Multiple Options

You can pass multiple options by separating them with a space. Keep in mind that any strings with a space should be wrapped in quotes. You can mix and match whether to use an equal or a space between the key and value.

prv directory-dimension:create --name "Sales Region" --handle=sales-rg

Boolean Flags

Boolean options do not take a true or false value. You either include the flag or you don’t. The common convention is --is_{boolean} for the positive case and --is_not_{boolean} for the negative case.

# Only managers
prv directory-user:list --is_manager

# Only non-managers
prv directory-user:list --is_not_manager

Table Tips

The :list commands support advanced filtering using exact and partial (fuzzy search). You can apply filters using the interactive menus below the list of results or by adding options when running the command.

Exact vs Partial Matches

Most database columns are encrypted and do not allow partial string searching. Provisionr has functionality in some places that allow us to fetch the contents, decrypt them, then perform partial searches. Throughout the API and CLI, the search keyword is used to indicate that partial matches are supported. If search is not included, assume that only exact matches will appear in your results. Most list commands support exact string matches using {field_name}= and partial string matches using the search keyword {field_name}_search= on most string fields. You can use --search for a full text search across most or all fields if it is available on that command.

prv directory-user:list --org_array_search="IT Security"
prv directory-user:list --last_name=Keyes
prv directory-user:list --full_name_search=Keyes
prv directory-user:list --email_search=gkeyes

Filtering Columns Without an Option

CLI options are associated with API server-side filters. When a column is shown in the table but no CLI option exists for it, use --where and --where-partial to filter it. These run similar to a SQL query on the client side, providing additional filtering that the API does not offer. --where matches exactly; --where-partial matches a substring. Both can be passed multiple times. For terminal table-width brevity, the filter is always based on the column name shown in the table or export list of records, including the dot. Any nested relationships in the included. array are automatically stripped of the prefix. Any resource names separated by an underscore are abbreviated to the string after the last underscore. For example, included.user_manager.full_name is manager.full_name.

prv directory-user:list --where=manager.full_name='Wren Odell'

Are you looking for a filter that doesn’t exist, or is an existing filter not intuitive? Let us know in Slack or a support ticket.

Date Filters

Any date or datetime filter should be in the format of YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. You can also use ISO 8601 timestamps such as YYYY-MM-DDTHH:MM:SS.00000Z. Some other formats may work, however they are not tested or supported. Try to avoid using month and date first when using dates since it may be interpreted as DD-MM-YYYY or MM-DD-YYYY. All times shown are in the UTC timezone.

prv directory-user:list --provisioned_after=2025-05-08

When a datetime is shown in a table or describe method, it may be color coded based on how recent the timestamp is relative to now. Any difference less than 24 hours is green. Any difference less than 7 days is cyan blue.

Including Deactivated Records

When a record is deactivated, it enters a soft-deleted state in the database. A soft delete lets us retain the record for the audit trail without including it in day-to-day results. Only non-deleted records are shown by default, so add the --deleted (or -D) flag to include them.

prv directory-user:list --deleted

Any PII in a deactivated record is anonymized with ghost-user information after the deactivated-user retention policy period has expired.

Customizing Table Columns

The API response for a record includes more fields than we can display in a Terminal window. We have selected opinionated defaults of which columns are most relevant. For example, directory-user:list --state=expiring does not show an expiration-date column by default, even though the data is available. There are only so many pixels and characters in a terminal window, and we cannot scroll right like you can in a web UI. You can customize which columns are shown from all of the available data three ways:

Choose the Edit Column Display Settings option in the menu after running a prv {namespace}-{resource}:list command.
Run the cli-settings:customize command directly.
Add --column=COLUMN_NAME when running a list command to show a column temporarily.

prv directory-user:list --state=expiring --column=timestamp.expires_at

Column names use dot notation with periods. These are flattened JSON array keys, so if you fetch the JSON data (see below), you can replace a nested array with a dot to reference the field you want. All settings are saved locally on your machine and only impact you. They apply whenever you run the list command for that resource until you change them. To reset back to the defaults, for one type of record or all settings globally, run the cli-settings:reset command.

prv cli-settings:customize
prv cli-settings:reset

There is no built-in way to re-order the display order of table columns. If you are comfortable editing JSON files, you can carefully edit ~/.config/provisionr/settings.json and re-order the comma-separated list in the columns array for the respective resource.

Raw Output for Scripts

Our interactive prompts are designed for a pleasant UX. If you are using scripts that rely solely on outputs of a command, add the --json flag on any list or describe command to get the structured JSON data response that the CLI received from the API. This lets you explore detailed information we don’t show by default and parse it with jq, awk, grep, and similar tools.

prv directory-user:list --json

When run interactively, you will be prompted whether you want to export the JSON results to a file, which saves in your ~/Downloads/provisionr/ folder.

Filtering JSON with jq

This is an advanced topic for those familiar with manipulating terminal output. Skip it if it isn’t relevant or useful to you.

Because --json emits standard JSON, you can pipe it straight into jq to pull out exactly the field you need. When using scripts, add --no-interaction (or -n) to disable interactive prompts, headers, and metadata. This ensures only the JSON data itself is returned, with a clean terminal exit code. Reference a key by its path to get a value. For example, a user’s job title lives under .org.title:

prv directory-user:describe -n --json --id drusr_01hq8xyzabc123def456ghi789 | jq '.org.title'

That prints the value with quotes ("IT Security Engineer"). Add the -r (raw) flag to strip the quotes. This is handy when assigning the result to a variable or feeding it into another command:

prv directory-user:describe -n --json --id drusr_01hq8xyzabc123def456ghi789 | jq -r '.org.title'

Keys that contain a hyphen must be quoted inside brackets, since jq reads a bare - as subtraction. To read a sibling field like cost-center, use .org["cost-center"].

Shorthand Commands

You can see a quick reference for all shorthand commands, including each namespace’s 2-character and resource’s 3-character shorthand, when running the prv command without any resources specified.

prv

The 5-character shorthand also matches the prefix on any record ID, so if you know the ID, you already know the shorthand. For example, a drusr_01ky996whrvahxf482atvpg6wx ID belongs to the drusr (Directory User) resource. For a many-to-many relationship where one resource is attached to another, the shorthand uses the first character of each resource. A role-attached user is rau.

# {namespace}-{resource}:{action}
prv directory-attribute:create

# {abbrev}:{action}
prv dratr:create

If you have additional muscle memory commands, you can add as many aliases to your Bash or ZSH profile as you’d like.

echo "alias porul:make='porul:create'" >> ~/.zshrc
source ~/.zshrc

Shorthand Options

All options use a double hyphen prefix (ex. --name). Some options have shorthand variations that you can see when running --help for a command. We have standardized the alphabet for shorthand to maintain consistency. As a result, not all options have a shorthand letter if a suitable letter was not available.

Lowercase Shorthand Option	Standardized Use Case
`-a`	`--attribute_id`
`-A`	`--activate`
`-b`	Not in Use
`-B`	Not in Use
`-c`	`--condition`
`-C`	`--column`
`-d`	`--dimension_id` or `--description`
`-D`	`--deleted`
`-e`	`--email` or `--expires_after_days`
`-E`	`--inherit_expiration`
`-f`	`--format`
`-F`	`--force`
`-g`	Not in Use
`-G`	Not in Use
`-h`	`--help`
`-H`	`--hide`
`-i`	`--id`
`-I`	Not in Use
`-j`	Not in Use
`-J`	Not in Use
`-k`	`--attribute_key` or `--key`
`-K`	Not in Use
`-l`	Not in Use
`-L`	Not in Use
`-m`	`--manager_id`
`-M`	Not in Use
`-n`	`--no-interaction`
`-N`	Not in Use
`-o`	Not in Use
`-O`	Not in Use
`-p`	`--policy_ruleset_id` or `--predecessor_id`
`-P`	`--no_predecessor`
`-q`	`--quiet`
`-Q`	Not in Use
`-r`	`--workspace_role_id` or `--policy_rule_id`
`-R`	Not in Use
`-s`	`--search`
`-S`	`--state`
`-t`	`--resource_type` or `--type`
`-T`	Not in Use
`-u`	`--directory_user_id` or `--workspace_user_id`
`-U`	Not in Use
`-v`	`--verbose`
`-V`	`--version`
`-w`	Not in Use
`-W`	Not in Use
`-x`	Not in Use
`-X`	Not in Use
`-y`	Not in Use
`-Y`	Not in Use
`-z`	Not in Use
`-Z`	Not in Use

​Overview

​Summary of Commands

​Resource Actions

​Resource Commands

​Roadmap Resources (Coming Soon)

​Interactive Prompts

​Interactive Menus

​Command Options

​Help Command

​Equals vs Spaces

​Quote Wrapped Strings

​Multiple Options

​Boolean Flags

​Table Tips

​Exact vs Partial Matches

​Filtering Columns Without an Option

​Date Filters

​Including Deactivated Records

​Customizing Table Columns

​Raw Output for Scripts

​Filtering JSON with jq

​Shorthand Commands

​Shorthand Options

Overview

Summary of Commands

Resource Actions

Resource Commands

Roadmap Resources (Coming Soon)

Interactive Prompts

Interactive Menus

Command Options

Help Command

Equals vs Spaces

Quote Wrapped Strings

Multiple Options

Boolean Flags

Table Tips

Exact vs Partial Matches

Filtering Columns Without an Option

Date Filters

Including Deactivated Records

Customizing Table Columns

Raw Output for Scripts

Filtering JSON with jq

Shorthand Commands

Shorthand Options