sim permission-groups is also spelled sim permission-group.
Every command below also accepts the global options.
Add permission group member
sim permission-groups members add [options]Add Permission Group Member (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--user <value> | Yes | Existing organization member to add. |
Bulk add permission group members
sim permission-groups members batch-add [options]Bulk Add Permission Group Members (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--user <value...> | No | User IDs to add; cannot be combined with --all-members (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--all-members | No | Add every current organization member; cannot be combined with --user. |
List permission group members
sim permission-groups members list [options]List Permission Group Members (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--sort-by <value> | No | Field used to sort the result. Accepted values: assignedAt, userId. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
Remove permission group member
sim permission-groups members remove <userId> [options]Remove Permission Group Member (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
userId | Yes | User identifier of the member to remove. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
-y, --yes | Yes | Confirm this operation. |
Create permission group
sim permission-groups create [options]Create Permission Group (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--name <value> | Yes | Group name, unique within the organization. |
--description <value> | No | Optional group description. |
--config <json|@file> | No | Permission restrictions to set. Omitted keys use the default permission configuration. (JSON, or @path / @- to read a file or stdin). |
--default | No | Whether the group is the organization default. Only one group can be the default. |
--no-default | No | Send --default as false. |
--workspace-ids <json|@file> | No | Workspace IDs targeted by a non-default group. Required when creating a non-default group; omit for a default group. (JSON, or @path / @- to read a file or stdin). |
Delete permission group
sim permission-groups delete <groupId> [options]Delete Permission Group (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
Get permission group
sim permission-groups get <groupId> [options]Get Permission Group (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
List permission groups
sim permission-groups list [options]List Permission Groups (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the group name. |
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
Update permission group
sim permission-groups update <groupId> [options]Update Permission Group (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--name <value> | No | Group name, unique within the organization. |
--description <value> | No | Group description. Null or an empty string clears it; omission leaves it unchanged. (--description null sends the word, not JSON null). |
--config <json|@file> | No | Patch of permission restrictions. Omitted keys remain unchanged; each supplied array replaces that entire list. (JSON, or @path / @- to read a file or stdin). |
--default | No | Whether the group is the organization default. Only one group can be the default. |
--no-default | No | Send --default as false. |
--workspace-ids <json|@file> | No | Workspace identifiers for a non-default group. Required on creation; an empty update makes the group inactive. (JSON, or @path / @- to read a file or stdin). |