- Checkmarx Documentation
- Checkmarx SCA
- Checkmarx SCA - User Guide
- User Management and Access Control
- Roles
Roles
Roles define a set of permissions in the system. Each user is assigned one or more roles. There are two general types of roles, Access Control roles and SCA activity roles. The system comes with a set of predefined roles. You can also create custom roles, specifying the set of permissions included in the role.
Notice
In addition to roles, there is an additional layer of access control based on Teams. Independent of their roles, users can only access Projects that are assigned to Teams of which they are a member, see Teams.
Predefined Roles
The following table describes the pre-defined roles.
Role | Description | Permissions |
---|---|---|
Admin / SCA Admin | Global administrator for your organization’s SCA account | All access control permissions (Manage Authentication Providers, Manage Clients, Manage Roles, Manage System Settings, Manage Users) + All SCA activity permissions (Administrate, Create Project, Delete Project, Edit Project, Manage Policy, Manage Risk, Scan, Delete Scan, View) |
Access Control Roles | ||
Access Control Manager | Administrator who manages access control but does not take action in the actual SCA functionality. | All access control permissions (Manage Authentication Providers, Manage Clients, Manage Roles, Manage System Settings, Manage Users) |
User Manager | Can manage the users in the system | Manage Users |
SCA Activities Roles | ||
SCA Manager | Manage all aspects of SCA functionality except for administrative actions. | Create Project, Delete Project, Edit Project, Manage Policy, Manage Risk, Scan, Delete Scan, View |
SCA External Platform User | A user who accesses SCA via an external app, e.g., CxGo. This is a read-only user who also has the ability to manage risk state (e.g., mark vulnerabilities as “Not Exploitable”). | Manage Risk, View |
SCA Scanner | Manages Projects and runs and views scans. | Create Project, Delete Project, Edit Project, Scan, View |
SCA Viewer | Can only view risk reports | View |
Creating Custom Roles
You can create custom roles which defines a set of permissions that will be assigned to users with that role.
To create a custom role:
In the main navigation, click User Management.
The Access Control screen opens in a new tab.
On the Access Control screen select the Roles tab.
Click on the New Role button.
A form opens for creating a new role.
In the Role name field enter a name for the role.
In the Description field enter a brief description of the role (required).
If you would like to assign Access Control permissions, do the following:
Click on the + button next to Access Control.
A list of Access Control permissions is shown.
Select the checkbox for the permissions that you would like to assign.
If you would like to assign SCA Activity permissions, do the following:
Click on the + button next to SCA.
A list of SCA Activity permissions is shown.
Select the checkbox for the permissions that you would like to assign.
Click Save.
Notice
The new role is created. You can assign this role to users.
Actions on Roles
You can perform the following actions on roles. These actions can be done both for predefined and custom roles.
Edit role - adjust the name, description and permissions for the role.
Duplicate role - create a new role based on an existing role (while maintaining the original role).
Delete role - delete a role.
To edit a role:
On the Access Control > Roles screen, click on the context menu at the end of the row of the relevant role.
Click Edit.
The role form with the current info filled in is displayed.
Edit the Role name and Description fields as desired.
If you would like to adjust the Access Control permissions, do the following:
Click on the + button next to Access Control.
A list of Access Control permissions is shown.
Select/deselect the checkboxes for the permissions that you would like to add/remove for the role.
If you would like to adjust the SCA Activity permissions, do the following:
Click on the + button next to SCA.
A list of SCA Activity permissions is shown.
Select/deselect the checkboxes for the permissions that you would like to add/remove for the role.
Click Save.
Notice
The new role configuration is saved and is applied to users with this role.
To duplicate a role:
On the Access Control > Roles screen, click on the context menu at the end of the row of the relevant role.
Click Duplicate.
The role form with the current info filled in and the name “Copy of…” is displayed.
Edit the Role name and Description fields as desired.
If you would like to adjust the Access Control permissions, do the following:
Click on the + button next to Access Control.
A list of Access Control permissions is shown.
Select/deselect the checkboxes for the permissions that you would like to add/remove for the role.
If you would like to adjust the SCA Activity permissions, do the following:
Click on the + button next to SCA.
A list of SCA Activity permissions is shown.
Select/deselect the checkboxes for the permissions that you would like to add/remove for the role.
Click Save.
Notice
The new role is created in addition to the original role which remains unchanged.
To delete a role:
On the Access Control > Roles screen, click on the context menu at the end of the row of the relevant role.
Click Delete.
A confirmation dialog appears.
Click Delete again.
Notice
The role is permanently deleted from the system.