Skip to main content

Roles

A role is a group of users with a set of permissions. Roles are used two ways:

  • Permissions: What people with the role can do in Termix.
  • Sharing: Share a host, folder or credential with a role instead of one person at a time. See sharing.

Built in roles​

RolePermissions
adminEverything. This can't be changed.
userAll host and credential permissions.

Every new account gets user. Admins get admin instead. Termix keeps the admin role in step with who is an admin, so give admin with Make admin on the user's page, not by adding the role.

Ready made roles​

New and upgraded servers also get these. They are normal roles: edit, rename or delete them. A deleted one doesn't come back.

RolePermissionsFor
Viewerhosts.view, credentials.viewPeople who only look.
Operatorhosts.*, credentials.viewPeople who run hosts but don't handle secrets.
Auditoradmin.audit.view, admin.users.view, admin.operations.viewReading the audit log, users, shares and operations.
Helpdeskadmin.users.view, admin.users.manage, admin.sessions.manageResetting passwords, turning accounts off, sessions.

Make a role​

In Settings, Roles, press New Role. Give it a name, a display name and a description. Then add users to it from their page in Settings, Users.

Permissions​

Press Edit permissions on a role. Permissions are grouped:

GroupPermissions
Hostshosts.view, hosts.create, hosts.edit, hosts.delete, hosts.share
Credentialscredentials.view, credentials.create, credentials.edit, credentials.delete, credentials.share
Administrationadmin.users.view, admin.users.manage, admin.audit.view, admin.roles.manage, admin.settings.manage, admin.sessions.manage, admin.operations.view, admin.plugins.manage
PluginsEach plugin adds its own, like docker.use. They are listed on each plugin's reference page.

A plugin's permissions show up when it is installed. Each plugin picks which built in roles get them at first.

Administration permissions​

PermissionLets someone
admin.users.viewOpen Settings, Users and the access review, and see account details.
admin.users.manageMake accounts, reset passwords and second factors, turn accounts off and on, approve them, make invite links and delete users.
admin.sessions.manageSee everyone's sessions and sign people out.
admin.audit.viewRead the audit log.
admin.roles.manageMake and edit roles and give them to users.
admin.settings.manageChange server settings like host defaults and tags.
admin.operations.viewSee every user's operation runs.
admin.plugins.manageInstall, update and turn plugins on and off.

Someone with these permissions who is not an admin still can't touch an admin's account, make someone an admin, or open other users' hosts and credentials. Someone who manages roles without being an admin can only give permissions they hold themselves.

From SSO or LDAP​

The Single sign-on and LDAP plugins can map groups from your identity provider to Termix roles, so roles follow the directory. A group mapped to admin makes the user an admin, and removing them from it removes admin at their next sign in.