You are reading the documentation for an outdated Corteza release. 2024.9 is the latest stable Corteza release.

Roles

The roles interface can be accessed by clicking on the "Roles" navigation item on the left navigation drawer under the system item group.

A role defines a user group with a specific set of permissions on the resources. A role is a key part of Corteza Role-Based Access Control (RBAC).

Each role has a name, a system handle and a set of permissions on resources.

The interface allows you to:

Managing permissions

To manage permissions related to the role resource, click on the "Permissions" button on the top right corner of the page. You can define:

Read any role

Determines if the given role is allowed to access information of any role,

Update any role

Determines if the given role is allowed to update the information of any role,

Delete any role

Determines if the given role is allowed to delete any role,

Manage members for any role

Determines if the given role is allowed to add or remove members to any role.

Adding roles

To add a new role, click on the "New" button on the top right corner of the page.

This opens a new interface where you can insert the basic information regarding the role.

  • Name,

  • handle.

After saving the role, a new interface is provided where you can edit the newly created role.

The role edit interface provides the following sections:

Basic information

This section allows you to edit basic information regarding the role, such as the name and it’s handle,

Role members

This section allows you to view, add or remove the users associated with the role.

The role edit interface also allows you to define permissions specific to the given role. It can be accessed by clicking on the "Permissions" link in the top right corner. You can define:

Read "(role name)"

Determines if the given role is allowed to access information of the given role,

Update "(role name)"

Determines if the given role is allowed to update the information of the given role,

Delete "(role name)"

Determines if the given role is allowed to delete the given role,

Manage members for "(role name)"

Determines if the given role is allowed to add or remove members to the given role.

Listing roles

Roles can be viewed on the table in the middle of the interface. The system supports a powerful search engine, from partial searching, finding only active roles and so on. It also supports pagination and sorting.

Editing roles

Roles can be edited by pressing on the edit icon next to each row in the role list, that opens up a new interface,

The role edit interface provides the following sections:

Basic information

This section allows you to edit basic information regarding the role, such as the name and it’s handle,

Role members

This section allows you to view, add or remove the users associated with the role.

The role edit interface also allows you to define permissions specific to the given role. It can be accessed by clicking on the "Permissions" link in the top right corner. You can define:

Read "(role name)"

Determines if the given role is allowed to access information of the given role,

Update "(role name)"

Determines if the given role is allowed to update the information of the given role,

Delete "(role name)"

Determines if the given role is allowed to delete the given role,

Manage members for "(role name)"

Determines if the given role is allowed to add or remove members to the given role.