prb employee-portal command reference

Manage employee portals. This page documents 4 commands under prb employee-portal.

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 employee-portal	Manage employee portals.	prb employee-portal <command>	View implementation
prb employee-portal list	List employee portals.	prb employee-portal list	View implementation
prb employee-portal update	Update employee portal settings.	prb employee-portal update	View implementation
prb employee-portal view	View employee portal settings.	prb employee-portal view	View implementation

prb employee-portal

Manage employee portals.

Usage

prb employee-portal <command>

View command implementation.

prb employee-portal list

List employee portals.

Usage

prb employee-portal list

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--after	string	""	—	Cursor from the previous page (the Next cursor line)
--json	boolean	false	—	Output JSON (same as —output json)
--limit, -L	integer	30	—	Maximum number of employee portals to list
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--org	string	""	—	Organization ID
--output, -o	string	""	—	Output format: json, table (default)

Examples

# List employee portals for the default organization
prb employee-portal list

# List employee portals for a specific organization
prb employee-portal ls --org <organization-id>

View command implementation.

prb employee-portal update

Update employee portal settings.

Usage

prb employee-portal update

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--active	boolean	false	—	Enable or disable the employee portal
--device-agent	boolean	false	—	Offer the device agent in the employee app
--name	string	""	—	Display name of the employee portal
--portal	string	""	Required	Employee portal ID

Examples

# Rename an employee portal
prb employee-portal update --portal <portal-id> --name "Acme Employees"

# Hide the device agent in the employee app
prb employee-portal update --portal <portal-id> --device-agent=false

View command implementation.

prb employee-portal view

View employee portal settings.

Usage

prb employee-portal view

Accepts no positional arguments.

Flags

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

Examples

# View an employee portal
prb employee-portal view --portal <employee-portal-id>

View command implementation.