Accounts

The accounts section is for the management of user accounts, access permissions, and tenants.

Users

Description of User account fields:

  • Username - Unique username.

  • Full Name - Full Name of the user.

  • E-mail - The email address of the user. Also used for system notifications and for password retrieval.

  • E-mail CC - Send copies of email notifications to this address.

  • Phone Number - User’s phone number.

  • Company - Company the user works for. Usually useful for multi-tenant systems where the company provides Netris Controller access to customers.

  • Position - Position within the company.

  • User Role - When using a User Role object to define RBAC (role-based access control), the Permission Group and Tenant fields will be deactivated.

  • Permission Group - User permissions for viewing and editing parts of the Netris Controller. (if User Role is not used)

  • +Tenant - User permissions for viewing and editing services using Switch Port and IP resources assigned to various Tenants. (if User Role is not used)

Example: Creating a user with full access to all sections of Netris Controller, read-only access to resources managed by any Tenant, and full access to resources assigned to the Tenant Admin.

Add User form with the user's details, User Role, Permission Group and Tenant fields.

Figure: User Management

Password: To set a password or email the user a password form, go to the username list and click the menu on the right.

User list with the row menu open, showing the option to set a password or email a password form.

Figure: List User Accounts

Accounts created here sign in with the built-in local authentication scheme. A controller connected to Active Directory also creates accounts automatically from AD group membership, and those appear in the same list — see Authentication.

Tenants

Tenants are named principals used to delegate management of network resources. The built-in Admin tenant owns all resources by default. Additional tenants grant other teams self-service access to provision and manage network services via the Netris Controller GUI, Kubernetes CRDs, or Terraform.

A Tenant object has only two fields: a unique name and an optional description. It carries no quota, billing identity, or login.

For a glossary of related concepts — including Admin Tenant and Guest Tenant — see Definitions.

Admin Tenant vs Guest Tenant

VPCs and V-Nets in Netris support two tenant roles:

  • The Admin Tenant owns the object and can manage all of its parameters.

  • Guest Tenants are tenants granted delegated access to add and remove resources inside the object, but cannot change the object’s parameters.

For a VPC, the Admin Tenant manages all VPC-level parameters. Guest Tenants of a VPC can add and remove services inside it — V-Nets, L4 Load Balancers, Server Clusters, IPAM subnets — but cannot change the VPC’s own parameters.

For a V-Net, the Admin Tenant manages all V-Net parameters. Guest Tenants of a V-Net can add and remove switch ports to the V-Net, but cannot change the V-Net’s own parameters.

Example: Adding a tenant.

Add Tenant form with the name and description fields.

Figure: Adding Tenants

Permission Groups

Permission Groups are a list of permissions per section that can be attached individually to a User or a User Role. Each section has View and Edit attributes. View defines whether users with this Permission Group can see the section at all. Edit defines if users with this Permission Group can edit services and policies in specific sections.

The two checkboxes combine as follows:

View

Edit

Result for the user

off

off

The section is hidden: it doesn’t appear in the menus.

on

off

The section is read-only: the user can look but not add, change or delete.

on

on

Full access to the section.

The checkboxes on a category’s own line (Services, Network, Accounts, Telescope, Settings) set View or Edit for every section in that category at once. The ACL section also has External ACL, which controls whether the user can manage ACLs with external networks.

Netris includes Permit All, which gives full access to every section. Create your own permission groups to give narrower access.

Example: Permission Group.

Permission Group form showing the per-section View and Edit checkboxes.

Figure: Managing Permissions

Example: a read-only permission group

Go to Accounts → Permission Groups → Add. In this example, Network Viewers lets members look at services, the network and Telescope without changing anything, and hides Accounts and Settings completely:

Add new Permission Group form named Network Viewers, with View checked across Services, Network and Telescope and for API Docs, Edit unchecked everywhere, and Accounts and Settings unchecked.

Figure: Network Viewers: View on Services, Network, Telescope and API Docs, no Edit, and Accounts and Settings hidden.

Click Add. The group appears in the list:

Permission Groups list filtered to the Network Viewers group.

Figure: The Network Viewers permission group in the list

A member of a user role that uses Network Viewers doesn’t see Accounts in the navigation, and their Settings menu only offers My Account and Log Out:

Left navigation of a Network Viewers user showing Services, Network and Telescope, with no Accounts item between Network and Telescope.

Figure: No Accounts item between Network and Telescope.

Settings menu of a Network Viewers user with only My Account and Log Out.

Figure: Only My Account and Log Out under Settings.

Tip

Permission groups and tenants. The permission group decides which sections a user can see and change. The tenants on the user (or on the user role) decide which tenants’ resources the user can work with, and whether they can change them. A user can change something only when both allow it.

User Roles

Permission Groups and Tenants can be linked either directly to an individual username or to a User Role object, which can then be linked to an individual username.

Add User Role form with the Name, Permission Group and Tenant fields.

Figure: User Roles

Go to Accounts → User Roles → Add. A user role has:

  • Name — a unique name for the role.

  • Permission Group — the sections members can see and change, for example Permit All for administrators, or Network Viewers from the example above.

  • +Tenant — the tenants members can work with. Tick Edit next to a tenant to allow changes there; leave it unticked for read-only access to that tenant. Choose All Tenants to cover every tenant at once.

Edit User Role form for a role named Netris-AD-Viewers with Permission Group set to Network Viewers and the Admin tenant added without Edit.

Figure: A role using the Network Viewers permission group, with read-only access to the Admin tenant.

Note

User roles and Active Directory. When the controller authenticates users against Active Directory, the role’s Name also does the group mapping: a role whose name matches an AD group’s CN is given to members of that group at sign-in. See Authentication.