Roles and grants
Weik.io 2026.2Weik.io comes with four roles. You can create custom roles from the same verbs. Video
Watch: Projects and environments, 3:07
The video explains projects and environments, and how people and pipelines get their roles through grants and API keys.
This part of the video couldn't be loaded.
On this page
In the admin UI and the weikio CLI alike, you can do only what your grants allow.
A grant gives a person or an API key one role in one project. You can limit a grant to some environments, and to some integrations or APIs of that project. A role is a named set of verbs, such as read or deploy.
The roles that ship#
Every installation comes with four roles. You can list the roles with any key:
$ weikio get rolesNAME 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 yeshelpdesk in this list is a custom role. A platform administrator can edit the four roles that come with Weik.io, but nobody can delete them.
The verbs#
| Verb | What it allows in the grant’s project and environments |
|---|---|
read |
See the project’s integrations, APIs, deployments, logs, metrics and traces |
author |
Create and change integrations, APIs, kamelets and variables |
operate |
Set secrets, start, stop and invoke integrations, and send dead letters again |
reveal |
Reveal a secret’s value, where the environment allows reveals |
deploy |
Deploy, promote and roll back into the environment |
entity- |
Set the entity store’s type policies |
members |
Manage the project’s members, when the grant covers the whole project |
Create a custom role#
Build a custom role from the verbs above with the CLI, or as a document in Git:
$ weikio role create helpdesk --verbs read --description "Reads production for support cases"apiVersion: weik.io/v1
kind: role
metadata: { name: helpdesk }
spec: { verbs: [read] }$ weikio apply -f platform/roles/helpdesk.yamlTarget: https://hub.example, project sandbox (context), environment devtest (context)
role helpdesk createdweikio role set helpdesk --verbs read,operate replaces a role’s verbs. weikio describe role helpdesk shows the projects where the role is granted.
When you delete a custom role, the grants that use it no longer allow anything. Creating a role with the same name later doesn’t change that.
How a grant works#
You write a grant in the CLI as project/role@environments, such as finance/deployer@devtest,production. A grant can also list the integrations and APIs it covers.
A user gets a grant through a membership. Limiting a membership has the rules for what a grant covers, which are the same for an API key and a claim mapping.
When you rename something a grant lists, the grant still covers it. The grant doesn’t cover something new that you later create under the old name. Projects and access shows how to give a grant to a person.
Platform administrators#
Platform administrator is a setting on a user that no role or verb gives. A platform administrator creates what belongs to the whole installation:
- Projects
- Environments
- Agents
- Users
- Providers
A platform administrator also sees the whole audit trail.
To make a user a platform administrator, set it on their account:
$ weikio user set pekka.niemi@example.com --platform-admin=trueFrom then on, each of the user’s local sign-ins needs a second factor.
Creating a role with the verb platform fails. To make someone a platform administrator, run the weikio user set command at the end of the error message.
A claim mapping can also make a person a platform administrator. They keep the platform administrator setting for 30 days after their last sign-in through the provider, unless you change the number of days with weikio provider set --roles-count-for.
Check what you can do#
weikio whoami shows your user and your grants:
$ weikio whoamiServer: https://hub.example (context local)
Key: 01m7mzdgte2nkywz5yd5cjcmd4
User: admin@local
Platform admin: yes
Grants: none
This key holds the grants listed and not roles added later. For a key that follows your roles, run:
weikio login https://hub.example --name local| Line | What it shows |
|---|---|
Server |
The installation |
Key, User |
The key and its user |
Platform admin |
Whether the key acts as a platform administrator |
Grants |
The key’s grants, in a table with their environments, integrations and APIs |
With an Only these key, the output ends with the weikio login command for a key that follows your roles, as above. With a key from weikio login, or an All my access key that you made while signed in through an identity provider, the output ends with a line that says how long the provider’s roles count, as in From your sign-in at entra. Counts for 30 days after your last sign-in there.
After that time, the key has only the roles given to you directly. To get the provider’s roles back, sign in to the admin UI in a browser, or run weikio login again.
In the admin UI, you manage access under Settings › Access. Each person sees only the pages their grants allow:
| Page | Who sees it |
|---|---|
| Project access, Audit log | Platform administrators and a project’s admins |
| Users, Agents, Providers, Health | Platform administrators only |