prb compliance-portal command reference

Manage compliance portal. This page documents 36 commands under prb compliance-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 compliance-portal	Manage compliance portal.	prb compliance-portal <command>	View implementation
prb compliance-portal access	Manage compliance portal visitors.	prb compliance-portal access <command>	View implementation
prb compliance-portal access activate	Activate a compliance portal visitor.	prb compliance-portal access activate <id>	View implementation
prb compliance-portal access create	Add a visitor to a compliance portal.	prb compliance-portal access create	View implementation
prb compliance-portal access deactivate	Deactivate a compliance portal visitor.	prb compliance-portal access deactivate <id>	View implementation
prb compliance-portal audit	Manage audits published on a compliance portal.	prb compliance-portal audit <command>	View implementation
prb compliance-portal audit delete	Remove an audit from a compliance portal.	prb compliance-portal audit delete <compliance-portal-audit-id>	View implementation
prb compliance-portal audit update	Update an audit visibility on a compliance portal.	prb compliance-portal audit update <audit-id>	View implementation
prb compliance-portal commitment	Manage compliance portal commitments.	prb compliance-portal commitment <command>	View implementation
prb compliance-portal commitment create	Create a compliance portal commitment.	prb compliance-portal commitment create	View implementation
prb compliance-portal commitment delete	Delete a compliance portal commitment.	prb compliance-portal commitment delete <id>	View implementation
prb compliance-portal commitment list	List compliance portal commitments.	prb compliance-portal commitment list	View implementation
prb compliance-portal commitment update	Update a compliance portal commitment.	prb compliance-portal commitment update <id>	View implementation
prb compliance-portal commitment-group	Manage compliance portal commitment groups.	prb compliance-portal commitment-group <command>	View implementation
prb compliance-portal commitment-group create	Create a compliance portal commitment group.	prb compliance-portal commitment-group create	View implementation
prb compliance-portal commitment-group delete	Delete a compliance portal commitment group.	prb compliance-portal commitment-group delete <id>	View implementation
prb compliance-portal commitment-group list	List compliance portal commitment groups.	prb compliance-portal commitment-group list	View implementation
prb compliance-portal commitment-group update	Update a compliance portal commitment group.	prb compliance-portal commitment-group update <id>	View implementation
prb compliance-portal create	Create a compliance portal.	prb compliance-portal create	View implementation
prb compliance-portal delete	Delete a compliance portal.	prb compliance-portal delete <portal-id>	View implementation
prb compliance-portal document	Manage documents published on a compliance portal.	prb compliance-portal document <command>	View implementation
prb compliance-portal document delete	Remove a document from a compliance portal.	prb compliance-portal document delete <compliance-portal-document-id>	View implementation
prb compliance-portal document update	Update a document visibility on a compliance portal.	prb compliance-portal document update <document-id>	View implementation
prb compliance-portal file	Manage compliance portal files.	prb compliance-portal file <command>	View implementation
prb compliance-portal file delete	Delete a compliance portal file.	prb compliance-portal file delete <id>	View implementation
prb compliance-portal file list	List compliance portal files.	prb compliance-portal file list	View implementation
prb compliance-portal list	List compliance portals.	prb compliance-portal list	View implementation
prb compliance-portal reference	Manage compliance portal references.	prb compliance-portal reference <command>	View implementation
prb compliance-portal reference create	Create a compliance portal reference.	prb compliance-portal reference create	View implementation
prb compliance-portal reference delete	Delete a compliance portal reference.	prb compliance-portal reference delete <id>	View implementation
prb compliance-portal reference list	List compliance portal references.	prb compliance-portal reference list	View implementation
prb compliance-portal third-party	Manage third parties published on a compliance portal.	prb compliance-portal third-party <command>	View implementation
prb compliance-portal third-party delete	Remove a third party from a compliance portal.	prb compliance-portal third-party delete <compliance-portal-third-party-id>	View implementation
prb compliance-portal third-party update	Publish a third party on a compliance portal.	prb compliance-portal third-party update <third-party-id>	View implementation
prb compliance-portal update	Update compliance portal settings.	prb compliance-portal update	View implementation
prb compliance-portal view	View compliance portal settings.	prb compliance-portal view	View implementation

prb compliance-portal

Manage compliance portal.

Usage

prb compliance-portal <command>

View command implementation.

prb compliance-portal access

Manage compliance portal visitors.

Usage

prb compliance-portal access <command>

View command implementation.

prb compliance-portal access activate

Activate a compliance portal visitor.

Usage

prb compliance-portal access activate <id>

Requires 1 positional argument.

View command implementation.

prb compliance-portal access create

Add a visitor to a compliance portal.

Usage

prb compliance-portal access create

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--document	string list	[]	—	Document IDs to grant (repeatable)
--email	string	""	—	Visitor email address
--file	string list	[]	—	Compliance portal file IDs to grant (repeatable)
--portal	string	""	Required	Compliance portal ID
--profile	string	""	—	Organization profile ID
--report	string list	[]	—	Report file IDs to grant (repeatable)

Examples

# Add by email
prb compliance-portal access create --portal PORTAL_ID --email visitor@example.com

# Add an existing organization member
prb compliance-portal visitor create --portal PORTAL_ID --profile PROFILE_ID

View command implementation.

prb compliance-portal access deactivate

Deactivate a compliance portal visitor.

Usage

prb compliance-portal access deactivate <id>

Requires 1 positional argument.

View command implementation.

prb compliance-portal audit

Manage audits published on a compliance portal.

Usage

prb compliance-portal audit <command>

View command implementation.

prb compliance-portal audit delete

Remove an audit from a compliance portal.

Usage

prb compliance-portal audit delete <compliance-portal-audit-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal audit update

Update an audit visibility on a compliance portal.

Usage

prb compliance-portal audit update <audit-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--portal	string	""	Required	Compliance portal ID (required)
--visibility	string	""	Required	Compliance portal visibility: RESTRICTED or PUBLIC (required)

Examples

# Publish an audit report publicly on a compliance portal
prb compliance-portal audit update <audit-id> --portal <compliance-portal-id> --visibility PUBLIC

View command implementation.

prb compliance-portal commitment

Manage compliance portal commitments.

Usage

prb compliance-portal commitment <command>

View command implementation.

prb compliance-portal commitment create

Create a compliance portal commitment.

Usage

prb compliance-portal commitment create

Flags

Flag	Type	Default	Required	Description
--description	string	""	—	Commitment description (required)
--eyebrow	string	""	—	Commitment eyebrow (required)
--group	string	""	—	Commitment group ID (required)
--icon	string	""	—	Commitment icon (required)
--title	string	""	—	Commitment title (required)

Examples

# Create a commitment interactively
prb compliance-portal commitment create --group <group-id>

# Create a commitment non-interactively
prb compliance-portal cmt create --group <group-id> --icon SHIELD_CHECK --eyebrow "Security" --title "Encryption" --description "Data encrypted at rest"

View command implementation.

prb compliance-portal commitment delete

Delete a compliance portal commitment.

Usage

prb compliance-portal commitment delete <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal commitment list

List compliance portal commitments.

Usage

prb compliance-portal commitment list

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--after	string	""	—	Cursor from the previous page (the Next cursor line)
--group	string	""	—	Commitment group ID (required)
--json	boolean	false	—	Output JSON (same as —output json)
--limit, -L	integer	30	—	Maximum number of commitments to list
--order-by	string	""	—	Order by field (RANK, CREATED_AT, UPDATED_AT)
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--output, -o	string	""	—	Output format: json, table (default)

Examples

# List commitments in a group
prb compliance-portal commitment list --group <group-id>

# List commitments sorted by rank
prb compliance-portal cmt ls --group <group-id> --order-by RANK

View command implementation.

prb compliance-portal commitment update

Update a compliance portal commitment.

Usage

prb compliance-portal commitment update <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--description	string	""	—	Commitment description
--eyebrow	string	""	—	Commitment eyebrow
--icon	string	""	—	Commitment icon
--rank	integer	0	—	Display rank
--title	string	""	—	Commitment title

Examples

# Update a commitment title
prb compliance-portal commitment update <id> --title "Encryption at rest"

# Update icon and rank
prb compliance-portal cmt update <id> --icon SHIELD_CHECK --rank 1

View command implementation.

prb compliance-portal commitment-group

Manage compliance portal commitment groups.

Usage

prb compliance-portal commitment-group <command>

View command implementation.

prb compliance-portal commitment-group create

Create a compliance portal commitment group.

Usage

prb compliance-portal commitment-group create

Flags

Flag	Type	Default	Required	Description
--description	string	""	—	Group description (required)
--org	string	""	—	Organization ID
--title	string	""	—	Group title (required)

Examples

# Create a commitment group interactively
prb compliance-portal commitment-group create

# Create a commitment group non-interactively
prb compliance-portal cg create --title "Security" --description "Our security commitments"

View command implementation.

prb compliance-portal commitment-group delete

Delete a compliance portal commitment group.

Usage

prb compliance-portal commitment-group delete <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal commitment-group list

List compliance portal commitment groups.

Usage

prb compliance-portal commitment-group 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 commitment groups to list
--order-by	string	""	—	Order by field (RANK, CREATED_AT, UPDATED_AT)
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--org	string	""	—	Organization ID
--output, -o	string	""	—	Output format: json, table (default)

Examples

# List commitment groups in the default organization
prb compliance-portal commitment-group list

# List commitment groups sorted by rank
prb compliance-portal cg ls --order-by RANK

View command implementation.

prb compliance-portal commitment-group update

Update a compliance portal commitment group.

Usage

prb compliance-portal commitment-group update <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--description	string	""	—	Group description
--rank	integer	0	—	Display rank
--title	string	""	—	Group title

Examples

# Update a commitment group title
prb compliance-portal commitment-group update <id> --title "Privacy"

# Update rank
prb compliance-portal cg update <id> --rank 2

View command implementation.

prb compliance-portal create

Create a compliance portal.

Usage

prb compliance-portal create

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--entity-name	string	""	—	Entity name shown on the public compliance page
--org	string	""	—	Organization ID

Examples

# Create a compliance portal interactively
prb compliance-portal create

# Create a compliance portal non-interactively
prb compliance-portal create --entity-name "Acme Corp"

View command implementation.

prb compliance-portal delete

Delete a compliance portal.

Usage

prb compliance-portal delete <portal-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal document

Manage documents published on a compliance portal.

Usage

prb compliance-portal document <command>

View command implementation.

prb compliance-portal document delete

Remove a document from a compliance portal.

Usage

prb compliance-portal document delete <compliance-portal-document-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal document update

Update a document visibility on a compliance portal.

Usage

prb compliance-portal document update <document-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--portal	string	""	Required	Compliance portal ID (required)
--visibility	string	""	Required	Compliance portal visibility: RESTRICTED or PUBLIC (required)

Examples

# Publish a document publicly on a compliance portal
prb compliance-portal document update <document-id> --portal <compliance-portal-id> --visibility PUBLIC

View command implementation.

prb compliance-portal file

Manage compliance portal files.

Usage

prb compliance-portal file <command>

View command implementation.

prb compliance-portal file delete

Delete a compliance portal file.

Usage

prb compliance-portal file delete <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal file list

List compliance portal files.

Usage

prb compliance-portal file 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 files to list
--order-by	string	""	—	Order by field (NAME, CREATED_AT, UPDATED_AT)
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--output, -o	string	""	—	Output format: json, table (default)
--portal	string	""	—	Compliance portal ID

Examples

# List files for a compliance portal
prb compliance-portal file list --portal <compliance-portal-id>

# List files sorted by name
prb compliance-portal file ls --portal <id> --order-by NAME

View command implementation.

prb compliance-portal list

List compliance portals.

Usage

prb compliance-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 compliance 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 compliance portals for the default organization
prb compliance-portal list

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

View command implementation.

prb compliance-portal reference

Manage compliance portal references.

Usage

prb compliance-portal reference <command>

View command implementation.

prb compliance-portal reference create

Create a compliance portal reference.

Usage

prb compliance-portal reference create

Flags

Flag	Type	Default	Required	Description
--description	string	""	—	Reference description
--name	string	""	—	Reference name (required)
--portal	string	""	Required	Compliance portal ID
--website	string	""	—	Website URL

Examples

# Create a reference interactively
prb compliance-portal reference create

# Create a reference non-interactively
prb compliance-portal ref create --name "Acme Corp" --description "Enterprise customer" --website "https://acme.com"

View command implementation.

prb compliance-portal reference delete

Delete a compliance portal reference.

Usage

prb compliance-portal reference delete <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal reference list

List compliance portal references.

Usage

prb compliance-portal reference 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 references to list
--order-by	string	""	—	Order by field (RANK, NAME, CREATED_AT, UPDATED_AT)
--order-direction	string	"DESC"	—	Sort direction (ASC, DESC)
--output, -o	string	""	—	Output format: json, table (default)
--portal	string	""	Required	Compliance portal ID

Examples

# List references in the default organization
prb compliance-portal reference list

# List references sorted by rank
prb compliance-portal ref ls --order-by RANK

View command implementation.

prb compliance-portal third-party

Manage third parties published on a compliance portal.

Usage

prb compliance-portal third-party <command>

View command implementation.

prb compliance-portal third-party delete

Remove a third party from a compliance portal.

Usage

prb compliance-portal third-party delete <compliance-portal-third-party-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--yes, -y	boolean	false	—	Skip confirmation prompt

View command implementation.

prb compliance-portal third-party update

Publish a third party on a compliance portal.

Usage

prb compliance-portal third-party update <third-party-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--portal	string	""	Required	Compliance portal ID (required)
--published	boolean	false	—	Publish the third party on the compliance portal

Examples

# Publish a third party on a compliance portal
prb compliance-portal third-party update <third-party-id> --portal <compliance-portal-id> --published

View command implementation.

prb compliance-portal update

Update compliance portal settings.

Usage

prb compliance-portal update

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--active	boolean	false	—	Enable or disable the compliance portal
--description	string	""	—	Compliance page description
--email	string	""	—	Compliance page contact email
--entity-name	string	""	—	Entity name shown on the public compliance page
--headquarter-address	string	""	—	Compliance page headquarter address
--portal	string	""	Required	Compliance portal ID
--rights-requests-enabled	boolean	false	—	Enable or disable rights requests on the compliance portal
--search-engine-indexing	string	""	—	Search engine indexing: INDEXABLE, NOT_INDEXABLE
--website-url	string	""	—	Compliance page website URL

Examples

# Enable the compliance portal
prb compliance-portal update --active

# Disable search engine indexing
prb compliance-portal update --search-engine-indexing NOT_INDEXABLE

# Disable rights requests on the portal
prb compliance-portal update --rights-requests-enabled=false

View command implementation.

prb compliance-portal view

View compliance portal settings.

Usage

prb compliance-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	Compliance portal ID

Examples

# View a compliance portal
prb compliance-portal view --portal <compliance-portal-id>

View command implementation.