CLICommand reference
Roles
Generated reference for nimbu roles
Generated from the CLI command contract. Do not edit this page manually.
nimbu roles
Manage roles
nimbu roles copy
Copy roles between sites
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--from | yes | Source site | |
--to | yes | Target site | |
--from-host | no | Source API base URL or host | |
--to-host | no | Target API base URL or host |
nimbu roles create
Create role from JSON
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. name=VIP) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--file | no | Read role JSON from file (use - for stdin) |
nimbu roles customers
Add, remove, or replace customers on a role
nimbu roles customers add
Add customers to a role
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID | |
--customer | yes | Customer ID to add, repeatable |
nimbu roles customers remove
Remove customers from a role
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID | |
--customer | yes | Customer ID to remove, repeatable |
nimbu roles customers set
Replace a role's customer list
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID | |
--customer | yes | Customer ID that should remain, repeatable |
nimbu roles delete
Delete role
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID |
nimbu roles get
Get role details
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID |
nimbu roles list
List roles
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Locale filter; localized resources use it as content locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--all | no | Fetch all pages | |
--page | no | 1 | Page number |
--per-page | no | 25 | Items per page |
nimbu roles update
Update a role. customers/children/parents arrays replace the whole relation; __op envelopes are passed through verbatim
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. name=VIP) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--role | yes | Role ID | |
--file | no | Read role JSON from file (use - for stdin) | |
--dry-run | no | Print the request body and relation diff without writing |