Skip to content
Try for free
On this page

Commands

Permission groups

Manage organization permission groups, their configuration, and member assignments.

Use the linked API request schema for the supported --config keys. Supplied arrays replace their entire lists; omitted settings remain unchanged on update.

sim permission-groups is also spelled sim permission-group.

These commands accept the global options.

Group configuration

List permission groups

OAuth login or personal API key required.

Code
sim permission-groups list [options]

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--search <value>NoCase-insensitive substring match against the group name.
--sort-by <value>NoField used to sort the result. Do not rely on case-insensitive ordering when sorting by name. Defaults to "createdAt". Accepted values: name, createdAt, updatedAt.
--sort-order <value>NoSort direction. Defaults to "desc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listPermissionGroups.

Get permission group

OAuth login or personal API key required.

Code
sim permission-groups get <groupId> [options]

Arguments

ArgumentRequiredDescription
groupIdYesPermission group identifier.

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.

API request and response schemas: getPermissionGroup.

Create permission group

OAuth login or personal API key required.

Code
sim permission-groups create [options]

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--name <value>YesGroup name, unique within the organization.
--description <value>NoOptional group description.
--config <json|@file>NoGroup settings to set. Omitted keys use the default permission configuration. (JSON, or @path / @- to read a file or stdin).
--defaultNoWhether the group is the organization default. Only one group can be the default.
--no-defaultNoSend --default as false.
--workspace-ids <json|@file>ConditionalWorkspace 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).

API request and response schemas: createPermissionGroup.

Update permission group

OAuth login or personal API key required.

Code
sim permission-groups update <groupId> [options]

Arguments

ArgumentRequiredDescription
groupIdYesPermission group identifier.

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--name <value>NoGroup name, unique within the organization.
--description <value>NoGroup description. Null or an empty string clears it; omission leaves it unchanged. (--description null sends the word, not JSON null).
--config <json|@file>NoPatch of group settings. Omitted keys remain unchanged; each supplied array replaces that entire list. (JSON, or @path / @- to read a file or stdin).
--defaultNoWhether the group is the organization default. Only one group can be the default.
--no-defaultNoSend --default as false.
--workspace-ids <json|@file>NoWorkspace 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).

API request and response schemas: updatePermissionGroup.

Member assignments

List permission group members

OAuth login or personal API key required.

Code
sim permission-groups members list [options]

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--group <value>YesPermission group identifier.
--sort-by <value>NoField used to sort the result. Defaults to "assignedAt". Accepted values: assignedAt, userId.
--sort-order <value>NoSort direction. Defaults to "asc". Accepted values: asc, desc.
--limit <n>NoMaximum items to return (0 for everything). Defaults to 0.

API request and response schemas: listPermissionGroupMembers.

Add permission group member

OAuth login or personal API key required.

Code
sim permission-groups members add [options]

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--group <value>YesPermission group identifier.
--user <value>YesExisting organization member to add.

API request and response schemas: addPermissionGroupMember.

Remove permission group member

OAuth login or personal API key required.

This removes the member assignment and changes which permission groups apply to the user.

Code
sim permission-groups members remove <userId> [options]

Arguments

ArgumentRequiredDescription
userIdYesUser identifier of the member to remove.

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--group <value>YesPermission group identifier.
-y, --yesYesConfirm this operation.

API request and response schemas: removePermissionGroupMember.

Bulk add permission group members

OAuth login or personal API key required.

Code
sim permission-groups members batch-add [options]

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
--group <value>YesPermission group identifier.
--user <value...>NoUser IDs to add; cannot be combined with --all-members (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
--all-membersNoAdd every current organization member; cannot be combined with --user.

API request and response schemas: bulkAddPermissionGroupMembers.

Delete groups

Delete permission group

OAuth login or personal API key required.

This permanently deletes the permission group and its member assignments.

Code
sim permission-groups delete <groupId> [options]

Arguments

ArgumentRequiredDescription
groupIdYesPermission group identifier.

Options

OptionRequiredDescription
--organization <value>YesOrganization identifier.
-y, --yesYesConfirm this operation.

API request and response schemas: deletePermissionGroup.

Related docs

Was this helpful?
Suggest an edit