prb rights-request command reference
Reference for 6 commands under prb rights-request, including usage, flag types and defaults, required flags, source examples, and implementation links
Manage rights requests. This page documents 6 commands under prb rights-request.
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
Section titled “Commands”| Command | Description | Usage | Source |
|---|---|---|---|
prb rights-request | Manage rights requests. | prb rights-request <command> | View implementation |
prb rights-request create | Create a new rights request. | prb rights-request create | View implementation |
prb rights-request delete | Delete a rights request. | prb rights-request delete <id> | View implementation |
prb rights-request list | List rights requests in an organization. | prb rights-request list | View implementation |
prb rights-request update | Update a rights request. | prb rights-request update <id> | View implementation |
prb rights-request view | View a rights request. | prb rights-request view <id> | View implementation |
prb rights-request
Section titled “prb rights-request”Manage rights requests.
prb rights-request <command>prb rights-request create
Section titled “prb rights-request create”Create a new rights request.
prb rights-request create| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--action-taken | string | "" | — | Action taken |
--contact | string | "" | — | Contact information |
--data-subject | string | "" | — | Data subject name (required) |
--deadline | string | "" | — | Deadline |
--details | string | "" | — | Request details |
--org | string | "" | — | Organization ID |
--state | string | "" | — | Request state: TODO, IN_PROGRESS, DONE (required) |
--type | string | "" | — | Request type: ACCESS, DELETION, PORTABILITY (required) |
Examples
Section titled “Examples”# Create a rights request interactivelyprb rights-request create
# Create a rights request non-interactivelyprb rights-request create --data-subject "John Doe" --type ACCESS --state TODOprb rights-request delete
Section titled “prb rights-request delete”Delete a rights request.
prb rights-request delete <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--yes, -y | boolean | false | — | Skip confirmation prompt |
prb rights-request list
Section titled “prb rights-request list”List rights requests in an organization.
prb rights-request listAccepts no positional arguments.
| 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 rights requests to list |
--order-by | string | "" | — | Order by field (CREATED_AT, DEADLINE, STATE, TYPE) |
--order-direction | string | "DESC" | — | Sort direction (ASC, DESC) |
--org | string | "" | — | Organization ID |
--output, -o | string | "" | — | Output format: json, table (default) |
Examples
Section titled “Examples”# List rights requests in the default organizationprb rights-request list
# List rights requests sorted by deadlineprb rights-request ls --order-by DEADLINE --output jsonprb rights-request update
Section titled “prb rights-request update”Update a rights request.
prb rights-request update <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--action-taken | string | "" | — | Action taken |
--contact | string | "" | — | Contact information |
--data-subject | string | "" | — | Data subject name |
--deadline | string | "" | — | Deadline |
--details | string | "" | — | Request details |
--state | string | "" | — | Request state: TODO, IN_PROGRESS, DONE |
--type | string | "" | — | Request type: ACCESS, DELETION, PORTABILITY |
prb rights-request view
Section titled “prb rights-request view”View a rights request.
prb rights-request view <id>Requires 1 positional argument.
| Flag | Type | Default | Required | Description |
|---|---|---|---|---|
--json | boolean | false | — | Output JSON (same as —output json) |
--output, -o | string | "" | — | Output format: json, table (default) |