Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Projects, members and roles

Weik.io 2026.2

Create projects with the weikio CLI and give people a role in each one, from Weik.io's roles or roles you define. Video

Watch: Projects, environments and access, 3:59

The video creates a project and an environment and grants a person access to them.

On this page

Weik.io comes with the roles viewer, editor, deployer and admin. A platform administrator can create more roles from a set of verbs:

Verb What it allows
read Reading the project’s records, logs, metrics and traces
author Writing integrations, APIs, kamelets and variables
operate Setting secrets, starting, stopping and invoking deployments, and resending events
reveal Showing a secret’s value, where the environment allows it
deploy Deploying, promoting and rolling back into an environment
entity-store-policy Creating and changing entity types
members Adding and removing the project’s members

You can limit a membership to named environments and to named integrations and APIs. A support person can then restart one integration in production and see nothing else of the project, as How memberships work explains.

You can also keep projects and memberships as YAML documents that weikio apply accepts, and roles too. The commands below make the same changes directly.

Commands on this page#

Command What it does
weikio project create Create a project.
weikio get projects List projects.
weikio describe project Show a project with its members and counts.
weikio project set Change a project.
weikio delete project Delete a project and everything in it.
weikio rename project Rename a project.
weikio member add Give a user a role in a project, in place of any role they had there.
weikio get members List the members of a project.
weikio member list List the members of a project.
weikio member remove Remove a user from a project.
weikio get roles List the roles with their verbs.
weikio describe role Show a role.
weikio role create Create a role from a set of verbs.
weikio role set Replace the verbs of a role.
weikio delete role Delete a custom role.
weikio rename role Rename a custom role.

The tables below leave out the flags every command accepts, such as --env and --project, which the CLI reference lists.

weikio project create#

Create a project. Weik.io also creates the project’s store for built versions, sized by --store-bytes.

Terminal
weikio project create <name> [--display-name S] [--description S] [--label k=v ...] [--store-bytes SIZE]
Argument or flag What it does
<name> Sets the project’s name.
--display-name <display-name> Sets the project’s display name.
--description <description> Sets the project’s description.
--label <label> Adds a label in k=v form. Repeat the flag for each label.
--store-bytes <store-bytes> Sets the size of the store for integration versions and build output. The default is 1GiB.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/projects/{name}.

Also written as weikio create project.

Terminal
$ weikio project create finance --display-name "Finance" --label team=finance
You see
Target: https://hub.example
project finance created (revision 4102)

weikio get projects#

List projects.

Terminal
weikio get projects [-l k=v]
Argument or flag What it does
-l <l> Shows only rows with every k=v label given.

Who can run it: a grant on the project whose role has read.

API: GET /api/v1/projects.

weikio describe project#

Show a project with its members and counts.

Terminal
weikio describe project <name>
Argument or flag What it does
<name> Identifies the project.

Who can run it: a grant on the project whose role has read.

API:

  • GET /api/v1/projects/{name}
  • GET /api/v1/projects/{name}/members
  • GET /api/v1/projects/{name}/integrations

weikio project set#

Change a project.

Terminal
weikio project set <name> [--display-name S] [--description S] [--label k=v] [--unlabel k] [--store-bytes SIZE]
Argument or flag What it does
<name> Identifies the project.
--display-name <display-name> Sets the project’s display name. Give “” to remove it.
--description <description> Sets the project’s description.
--label <label> Adds or replaces a label in k=v form. Repeat the flag for each label.
--unlabel <unlabel> Removes the label with this key. Repeat the flag for each label you remove.
--store-bytes <store-bytes> Sets the size of the store for integration versions and build output. It must be above what the store uses.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/projects/{name}.

weikio delete project#

Delete a project and everything it has in every environment:

  • Its integrations and their versions
  • Its stored events and dead letters
  • Its entity types
  • Its values

To confirm the delete, type the project’s name.

Terminal
weikio delete project <name> [-y]
Argument or flag What it does
<name> Identifies the project.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: DELETE /api/v1/projects/{name}.

weikio rename project#

Rename a project.

Terminal
weikio rename project <name> <new-name>
Argument or flag What it does
<name> Identifies the project.
<new-name> Sets the new name.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PATCH /api/v1/projects/{project}.

weikio member add#

Give a user a role in a project.

The command replaces any role the user had in the project. For a new member, a grant without --integrations and --apis covers the whole project. For an existing member, only the values you give change. When you give a limit flag an empty value, the command fails and changes nothing.

If you aren’t a platform administrator, you can look up 30 e-mail addresses a minute on each hub server. The next lookup fails with HTTP 429 and Retry-After. The audit log records each of your lookups.

Terminal
weikio member add <project> <id|email> --role R [--env E,...] [--integrations N,...] [--apis A,...]
Argument or flag What it does
<project> Identifies the project.
<user> Identifies the user by ID or e-mail.
--role <role> Sets the role to grant.
--integrations <integrations> Sets the integrations the grant covers, comma separated, or '*' to clear the list. A grant that lists no integrations and no APIs covers the whole project.
--apis <apis> Sets the APIs the grant covers, comma separated, or '*' to clear the list. A grant that lists no integrations and no APIs covers the whole project.
--env, --environment <env> Sets the environments the grant covers, comma separated, or '*' for every environment. A new member gets every environment by default.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a grant on the project whose role has members, as admin has.

API:

  • GET /api/v1/users/_emails?email=
  • GET /api/v1/projects/{project}/members/{userId}
  • PUT /api/v1/projects/{project}/members/{userId}
Terminal
$ weikio member add finance anna@example.com --role deployer --env devtest,production
You see
Target: https://hub.example, project finance (argument), user anna@example.com
member finance/anna@example.com created (role deployer; environments devtest, production; revision 4104)
Terminal
$ weikio member add finance ville@example.com --role helpdesk --env production --integrations erp-invoice-export,nightly-payroll
You see
Target: https://hub.example, project finance (argument), user ville@example.com
member finance/ville@example.com created (role helpdesk; environments production; integrations erp-invoice-export, nightly-payroll; revision 4105)
Terminal
$ weikio member add finance anna@example.com --role deployer --env ''
You see
error: --env lists no environment. Give it a list of environments, or '*' for every environment.

weikio get members#

List the members of a project. The MAPPED column shows the grants a member got from claim mappings at their last sign-in through an identity provider. A - means they got none.

Terminal
weikio get members <project>
Argument or flag What it does
<project> Identifies the project.

Who can run it: a grant on the project whose role has members, as admin has.

API: GET /api/v1/projects/{project}/members, GET /api/v1/users/_emails?ids=.

Terminal
$ weikio get members finance
You see
USER          ROLE     MAPPED   ENVIRONMENTS   INTEGRATIONS   APIS
admin@local   viewer   -        devtest        all            all

weikio member list#

List the members of a project.

Terminal
weikio member list <project> [flags]
Argument or flag What it does
<project> Identifies the project.

Who can run it: a grant on the project whose role has members, as admin has.

API: GET /api/v1/projects/{project}/members, GET /api/v1/users/_emails?ids=.

Also written as weikio get members.

weikio member remove#

Remove a user from a project.

Terminal
weikio member remove <project> <id|email> [-y]
Argument or flag What it does
<project> Identifies the project.
<user> Identifies the user by ID or e-mail.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a grant on the project whose role has members, as admin has.

API: GET /api/v1/users/_emails?email=, DELETE /api/v1/projects/{project}/members/{userId}.

weikio get roles#

List the roles with their verbs.

Terminal
weikio get roles

Who can run it: any valid API key.

API: GET /api/v1/roles.

Terminal
$ weikio get roles
You see
NAME       VERBS                                                                 SEEDED
admin      read, author, operate, reveal, deploy, entity-store-policy, members   yes
deployer   read, author, operate, reveal, deploy, entity-store-policy            yes
editor     read, author, operate, reveal                                         yes
helpdesk   read                                                                  no
viewer     read                                                                  yes

weikio describe role#

Show a role.

Terminal
weikio describe role <name>
Argument or flag What it does
<name> Identifies the role.

Who can run it: any valid API key.

API: GET /api/v1/roles/{name}.

weikio role create#

Create a role from a set of verbs. Roles are platform-wide.

Terminal
weikio role create <name> --verbs v1,v2 [--description S]
Argument or flag What it does
<name> Sets the role’s name.
--verbs <verbs> Sets the role’s verbs, comma separated.
--description <description> Says what the role is for.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/roles/{name}.

Also written as weikio create role.

Terminal
$ weikio role create helpdesk --verbs read
You see
Target: https://hub.example
role helpdesk created (verbs read, revision 99)

weikio role set#

Replace the verbs of a role.

Terminal
weikio role set <name> --verbs v1,v2 [--description S]
Argument or flag What it does
<name> Identifies the role.
--verbs <verbs> Sets the role’s verbs, comma separated.
--description <description> Says what the role is for.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/roles/{name}.

weikio delete role#

Delete a custom role.

Terminal
weikio delete role <name> [-y]
Argument or flag What it does
<name> Identifies the role.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: DELETE /api/v1/roles/{name}.

weikio rename role#

Rename a custom role.

Terminal
weikio rename role <name> <new-name>
Argument or flag What it does
<name> Identifies the role.
<new-name> Sets the new name.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PATCH /api/v1/roles/{name}.

Exit codes#

The codes match the exit code table in the CLI reference.

Code Meaning
0 The command succeeded.
1 The command stopped without making the change.
2 The command has a usage error.
3 Your key is missing, expired or revoked, or its access doesn’t cover the command.
4 What you named doesn’t exist.
5 The change conflicts with another change.
6 Weik.io couldn’t be reached or wasn’t ready, or it was rate limiting your calls or out of storage. Run the command again later.
8 A document isn’t valid.

See also#

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo