Skip to main content

invite

Create and manage workspace invitations. Invites allow new users to join your workspace.

zopp invite <COMMAND>

Commands

CommandDescription
createCreate a new workspace invite
listList all invites for a workspace
revokeRevoke an existing invite

invite create

Create a new workspace invite. The invite contains an encrypted copy of the workspace KEK that the invitee can decrypt using the invite token.

zopp invite create [OPTIONS]

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace to create invite for
--expires-hours <HOURS>NoHours until invite expires (default: 168 = 7 days)
--plainNoOutput only the invite code (useful for scripts)
-h, --helpNoPrint help

Examples

# Create invite with default expiration (7 days)
$ zopp invite create -w mycompany
Invite created for workspace "mycompany"
Token: inv_a1b2c3d4e5f6...
Expires: 2024-01-15 14:30:00 UTC

Share this token with the user. They can join using:
zopp join inv_a1b2c3d4e5f6... user@example.com

# Create invite that expires in 24 hours
zopp invite create -w mycompany --expires-hours 24

# Get just the token for scripting
TOKEN=$(zopp invite create -w mycompany --plain)

invite list

List all invites for workspaces you have access to.

zopp invite list

Options

OptionDescription
-h, --helpPrint help

Example

$ zopp invite list
WORKSPACE EXPIRES STATUS
mycompany 2024-01-15 14:30:00 pending
mycompany 2024-01-10 09:00:00 expired
acme-corp 2024-01-20 00:00:00 pending

invite revoke

Revoke a pending invite so it can no longer be used.

zopp invite revoke <INVITE_ID>

Arguments

ArgumentRequiredDescription
INVITE_IDYesID of the invite to revoke

Example

$ zopp invite revoke inv_a1b2c3d4e5f6
Invite revoked