Skip to main content

group

Manage user groups. Groups make it easier to manage permissions for multiple users at once.

zopp group <COMMAND>

Commands

Group Management

CommandDescription
createCreate a new group
listList groups in a workspace
deleteDelete a group
updateUpdate group name or description

Membership

CommandDescription
add-memberAdd a user to a group
remove-memberRemove a user from a group
list-membersList members of a group

Workspace Permissions

CommandDescription
set-permissionSet workspace permission for a group
get-permissionGet workspace permission for a group
remove-permissionRemove workspace permission for a group
list-permissionsList all group permissions on a workspace

Project Permissions

CommandDescription
set-project-permissionSet project permission for a group
get-project-permissionGet project permission for a group
remove-project-permissionRemove project permission for a group
list-project-permissionsList group permissions on a project

Environment Permissions

CommandDescription
set-env-permissionSet environment permission for a group
get-env-permissionGet environment permission for a group
remove-env-permissionRemove environment permission for a group
list-env-permissionsList group permissions on an environment

Group Management

group create

Create a new group in a workspace.

zopp group create -w <WORKSPACE> <NAME> [DESCRIPTION]

Arguments

ArgumentRequiredDescription
NAMEYesGroup name
DESCRIPTIONNoGroup description

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name

Example

zopp group create -w mycompany developers "Backend development team"

group list

List all groups in a workspace.

zopp group list -w <WORKSPACE>

group delete

Delete a group.

zopp group delete -w <WORKSPACE> <NAME>

group update

Update a group's name or description.

zopp group update -w <WORKSPACE> <NAME> [--name <NEW_NAME>] [--description <DESC>]

Membership Management

group add-member

Add a user to a group.

zopp group add-member -w <WORKSPACE> -g <GROUP> --email <EMAIL>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
-g, --group <GROUP>YesGroup name
--email <EMAIL>YesUser email to add

Example

zopp group add-member -w mycompany -g developers --email alice@example.com

group remove-member

Remove a user from a group.

zopp group remove-member -w <WORKSPACE> -g <GROUP> --email <EMAIL>

group list-members

List all members of a group.

zopp group list-members -w <WORKSPACE> -g <GROUP>

Group Permissions

group set-permission

Set workspace-level permission for a group.

zopp group set-permission -w <WORKSPACE> -g <GROUP> -r <ROLE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
-g, --group <GROUP>YesGroup name
-r, --role <ROLE>YesPermission role: read, write, or admin

Example

# Give developers write access to the workspace
zopp group set-permission -w mycompany -g developers -r write

group set-project-permission

Set project-level permission for a group.

zopp group set-project-permission -w <WORKSPACE> --project <PROJECT> -g <GROUP> -r <ROLE>

group set-env-permission

Set environment-level permission for a group.

zopp group set-env-permission -w <WORKSPACE> --project <PROJECT> -e <ENV> -g <GROUP> -r <ROLE>

Example

# Give developers write access to development, read access to production
zopp group set-env-permission -w mycompany --project backend -e development -g developers -r write
zopp group set-env-permission -w mycompany --project backend -e production -g developers -r read