Skip to content

ptkl users

Invite and remove project users from the command line.

Overview

ptkl users manages human user accounts on your project. Use it to invite new users by email and assign them roles, or remove users who should no longer have access.

Subcommands

Subcommand Description
invite Invite a user to the project
delete Remove a user from the project

ptkl users invite

Send an invitation to a user by email and assign one or more roles.

ptkl users invite [options]

Options

Option Description
-e, --email <email> Email address of the user to invite
-r, --roles <roles...> One or more role UUIDs to assign to the invited user

Example

ptkl users invite \
  --email developer@example.com \
  --roles editor-role-uuid viewer-role-uuid

The user receives an email invitation and gains access to the project with the specified roles upon accepting.

ptkl users delete

Remove a user from the project by UUID.

ptkl users delete [options]

Options

Option Description
-u, --uuid <uuid> UUID of the user to remove

Example

ptkl users delete --uuid 550e8400-e29b-41d4-a716-446655440000

Warning

Removing a user immediately revokes their access to the project. This action cannot be undone — the user must be re-invited to regain access.

See Also