prb user command reference

Manage users. This page documents 5 commands under prb user.

Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.

Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.

Commands

Command	Description	Usage	Source
prb user	Manage users.	prb user <command>	View implementation
prb user deactivate	Deactivate a user.	prb user deactivate <id>	View implementation
prb user list	List users in an organization.	prb user list	View implementation
prb user remove	Remove a user.	prb user remove <id>	View implementation
prb user view	View a user.	prb user view <id>	View implementation

prb user

Manage users.

Usage

prb user <command>

View command implementation.

prb user deactivate

Deactivate a user.

Usage

prb user deactivate <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--org	string	""	—	Organization ID
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb user list

List users in an organization.

Usage

prb user list

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--after	string	""	—	Cursor from the previous page (the Next cursor line)
--contract-ended	string	""	—	Filter by contract status (true or false)
--filter, -q	string	""	—	Filter users by name or email search query
--json	boolean	false	—	Output JSON (same as —output json)
--kind	string	""	—	Filter by profile kind (EMPLOYEE, CONTRACTOR, SERVICE_ACCOUNT)
--limit, -L	integer	30	—	Maximum number of users to list
--order-by	string	""	—	Order by field (FULL_NAME, CREATED_AT, KIND)
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--org	string	""	—	Organization ID
--output, -o	string	""	—	Output format: json, table (default)
--role	string	""	—	Filter by membership role (OWNER, ADMIN, VIEWER, AUDITOR, EMPLOYEE, COMPLIANCE_PORTAL_MANAGER, COMPLIANCE_PORTAL_ACCESS_MANAGER)
--state	string list	[]	—	Filter by profile state; repeat or comma-separate for multiple (PENDING, ACTIVE, DEACTIVATED)

Examples

# List users in the default organization
prb user list

# List only active users
prb user ls --state ACTIVE

# Search users by name or email
prb user ls --filter alice

# List only admins
prb user ls --role ADMIN

# Filter by type
prb user ls --kind EMPLOYEE

# List users whose contract has ended
prb user ls --contract-ended true

View command implementation.

prb user remove

Remove a user.

Usage

prb user remove <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--org	string	""	—	Organization ID
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb user view

View a user.

Usage

prb user view <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.