Skip to main content
Version: Current

Access control

Access control is how an administrator decides who may do what: which scenarios a person may see, edit or deploy, who may call a deployed service, who may administer access itself. It is made of roles assigned to users, groups and service accounts, with an audit on top. It is managed in the Designer, under Administration in the menu: Users, Service accounts, Roles and Audit, each an entry of its own. There is no separate Access control menu item. Nothing has to be edited in a file.

Managing access needs the RBAC.Manage action. The built-in Admin role grants everything, present and future, and an administrator holds it; the change history can also be read with RBAC.ViewAuditLog alone.

Roles​

A role is a named set of actions and a scope. Actions are named after what they allow - Scenario.View, Scenario.Edit, Scenario.Deploy, Scenario.Stop, Scenario.Test, Scenario.Create, Scenario.Archive, Scenario.Delete, Scenario.ViewLiveData and the like - and the scope says in which scenario categories they apply: All current and future categories or Specific categories. Global actions, such as RBAC.Manage, have no category.

The role editor picks the actions as an access level per resource: Viewer, Editor, Maintainer and, for scenarios, Operator. Each level says in a sentence what it allows and what it leaves out - an Editor of scenarios creates, edits and archives them but cannot test or deploy, an Operator tests, deploys and stops them but cannot change them. The scenario levels are the permissions of the users file: Editor is Read and Write, Operator Read and Deploy, Maintainer all three, so a role migrated from the file reads as a level; deleting a scenario is granted on top. Customize opens the full list of actions, for a role that needs one more action on top of a level or a mix no level gives, and for a resource that has no levels, such as Core: adding one opens its actions to pick from, and its row then names the ones picked. A role is named by whoever creates it and keeps its actions, not its level: a level is not a role, only a way to pick actions.

Two actions apply to the resources themselves rather than to categories:

  • Scenario.Invoke - calling a deployed request-response scenario;
  • MCP.Use - calling the tools of an MCP server.

A role has one list of categories, and it confines Scenario.Invoke as much as Scenario.View. An MCP server belongs to no category, so a role can't hold MCP.Use. A role never names a single scenario or server - that is direct access, given to an account or a group.

Roles are created, cloned and edited under Roles. A role grants nothing by itself until it is assigned to someone.

Users and service accounts​

A role can be assigned to three kinds of account. Users lists the first two:

  • a local user - a person signing in with a login and a password kept by Nussknacker. Created under Users with Create local user: a login, a password you set or let the Designer generate (shown once), and the roles to assign;
  • an IdP group - stands for everyone an identity provider (OpenID Connect, OAuth2) reports with one of the group values it recognises. An installation that signs people in through an identity provider grants access this way, without a local account per person: a person holds the roles assigned to every group their sign-in carries.

Service accounts lists the third:

  • a service account - a machine client: a CI pipeline, an integration, an MCP client, nu-cli on a server. It has no password and signs in only with its API tokens. Created under Service accounts: a name and the roles to assign; it can do nothing until it has a token.

An MCP server keeps a service account of its own for its clients, created with its first token. The server decides what the account may do and how long it lives: its access follows the server's tools, it cannot be given roles or direct access by hand, and deleting the server deactivates it and revokes its tokens. Its credentials stay with the administrator: a token for it is issued and revoked by anyone holding RBAC.Manage, from the server's MCP tab or from the account's page, and so will any other credential a later version adds. Deactivating the account by hand cuts the server's clients off until it is reactivated: no new token is issued for the server meanwhile. Its page names the server it belongs to.

Role assignments​

A role assignment gives a role to a user, group or service account, optionally until a date; an expired assignment grants nothing. Roles are assigned on the account's page, under Roles: Assign role gives one or more roles, each with its expiry, under one reason; Change sets a role's new expiry and the cross revokes it, each saved at once with its own reason. On the role's page, Assign to an account gives it to several accounts at once. What they can do, on the account's page, adds the roles up in the same levels a role is edited in, per category, with the actions behind them one switch away. An account that holds the Admin role has full access regardless of its other roles.

Everyone sees their own roles and what they allow, globally and per category, under Profile in the user menu.

Direct access​

Direct access gives an account or a group Scenario.Invoke or MCP.Use on chosen scenarios or servers, outside any role - the way to let a CI pipeline call two scenarios without giving it a whole category. It is set on the account's page, under Direct access, per action, optionally until a date and with a reason for the audit log - or, for a service account, as it is created. Every token of a service account calls what the account's direct access names.

The grant follows the scenario or server, not its name: a rename does not move it, and when the scenario or server is deleted the grant is flagged as pointing at nothing, which creating one with the same name later does not revive.

Audit​

Audit has two tabs:

  • Change history - every change to access - a role created or edited, a role assigned, removed or expired, direct access given or taken away, an account created or deactivated, an API token issued or revoked - is recorded with who made it and when. It needs RBAC.ViewAuditLog, and Audit opens on it for whoever holds that;
  • Who has access answers the question the other way round: for a category, who may do what in it - every person, group and service account with a role that reaches the category or direct access to a scenario in it, with the actions they hold. It needs RBAC.Manage.

See also​

  • API tokens - credentials for nu-cli, scripts, CI and other machine clients.