Skip to main content

permission

Manage role-based access control (RBAC) permissions. Permissions can be set at workspace, project, or environment level for principals, users, or groups.

zopp permission <COMMAND>

Permission Levels

RoleDescription
readCan read secrets
writeCan read and write secrets
adminFull access including managing permissions

Commands Overview

Principal Permissions

CommandDescription
setSet workspace permission for a principal
getGet workspace permission for a principal
listList all permissions on a workspace
removeRemove workspace permission for a principal
project-setSet project permission for a principal
project-getGet project permission for a principal
project-listList project permissions
project-removeRemove project permission
env-setSet environment permission for a principal
env-getGet environment permission for a principal
env-listList environment permissions
env-removeRemove environment permission

User Permissions (by email)

CommandDescription
user-setSet workspace permission for a user
user-getGet workspace permission for a user
user-listList all user permissions on a workspace
user-removeRemove workspace permission for a user
user-project-setSet project permission for a user
user-project-getGet project permission for a user
user-project-listList user project permissions
user-project-removeRemove project permission for a user
user-env-setSet environment permission for a user
user-env-getGet environment permission for a user
user-env-listList user environment permissions
user-env-removeRemove environment permission for a user

Utility

CommandDescription
effectiveShow aggregated effective permissions for a principal

Workspace Permissions

permission set

Set workspace-level permission for a principal.

zopp permission set -w <WORKSPACE> -p <PRINCIPAL> -r <ROLE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
-p, --principal <PRINCIPAL>YesPrincipal ID
-r, --role <ROLE>YesPermission role: read, write, or admin

Example

zopp permission set -w mycompany -p 550e8400-... -r write

permission get

Get workspace permission for a principal.

zopp permission get -w <WORKSPACE> -p <PRINCIPAL>

permission list

List all principal permissions on a workspace.

zopp permission list -w <WORKSPACE>

permission remove

Remove workspace permission for a principal.

zopp permission remove -w <WORKSPACE> -p <PRINCIPAL>

Project Permissions

permission project-set

Set project-level permission for a principal.

zopp permission project-set -w <WORKSPACE> --project <PROJECT> -p <PRINCIPAL> -r <ROLE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
--project <PROJECT>YesProject name
-p, --principal <PRINCIPAL>YesPrincipal ID
-r, --role <ROLE>YesPermission role

permission project-list

List all principal permissions on a project.

zopp permission project-list -w <WORKSPACE> --project <PROJECT>

Environment Permissions

permission env-set

Set environment-level permission for a principal.

zopp permission env-set -w <WORKSPACE> --project <PROJECT> -e <ENVIRONMENT> -p <PRINCIPAL> -r <ROLE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
--project <PROJECT>YesProject name
-e, --environment <ENVIRONMENT>YesEnvironment name
-p, --principal <PRINCIPAL>YesPrincipal ID
-r, --role <ROLE>YesPermission role

User Permissions

User permissions work the same as principal permissions but use email addresses instead of principal IDs.

permission user-set

Set workspace permission for a user by email.

zopp permission user-set -w <WORKSPACE> --email <EMAIL> -r <ROLE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
--email <EMAIL>YesUser email address
-r, --role <ROLE>YesPermission role

Example

zopp permission user-set -w mycompany --email alice@example.com -r admin

Effective Permissions

permission effective

Show the aggregated effective permissions for a principal across all levels (workspace, projects, environments).

zopp permission effective -w <WORKSPACE> -p <PRINCIPAL>

Example

$ zopp permission effective -w mycompany -p 550e8400-...
SCOPE ROLE
workspace: mycompany admin
project: backend write (inherited)
env: development write (inherited)
env: production read (explicit)
project: frontend write (inherited)