General

GUI Reference: Roles

This page lists all roles on the hub, with links to the Role Users page for each. It also provides functionality for creating new roles and for deleting roles.

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Navigating to

From Click Roles in the link bar (under the page heading).
by URL: http://hub_location/roles.html

Page Properties

Output formats CSV, JSON, XML (roles.xsd)
Visibility Filter Applied none
RBAC Permissions Needed
Page Contents/FunctionalityG_ADMINISTER_USERS
G_MANAGE_USERS
ROLE_DELETE
ROLE_EXISTS

Page Contents

The following annotated screenshot shows the various parts of a Roles page.

Annotated Screenshot: Roles Page standard header breadcrumbs page heading links and information table of roles Delete Roles button functionality for creating a new role standard footer

Standard Header See GUI Reference: Standard Header.
Breadcrumbs Home > Settings > Roles
Where
Page Heading Roles
Links and Information Links to other RBAC-related pages: Users, Roles (this page), Global Role-Permissions, Root Project Tree Permissions, Root Launch Daemon Group Permissions. The latter two links are to the Resource Role-Permissions pages for the root project tree and root launchd group, respectively.
Role Table

A table with one row for each role.

  • If you have G_ADMINISTER_USERS permission, the table will list all roles on the hub.
  • Otherwise, the table will list all roles for which you have ROLE_EXISTS permission, plus all roles that you are assigned.

The table has standard pagination controls.

The available table columns are as follows. Columns displayed by default are marked with an asterisk (*).

Column Label Column Data
ID Role ID
Role * Role Name
Role Description * Role Description
black key icon *
("Permissions Link")		 Click grey key icon to navigate to the corresponding Role (Resource) Role-Permissions page.
Delete Roles button Click to delete one or more of the roles from the hub. See Delete Roles for full instructions.
Create New Role Use this form to create a new role. See Create a New Role for full instructions.
Standard Footer See GUI Reference: Standard Footer.

Delete Roles

If you have G_ADMINISTER_USERS permission, you can delete any deletable role. Otherwise, you can delete only roles for which you have ROLE_DELETE permission.

Follow these steps to remove all information related to one or more roles from the hub database.

  1. Click the Delete Roles button under the table of roles. The page will expand to provide more functionality, as shown below.

    screenshot fragment: expansion after clicking Delete Roles

    Checkboxes The table will update to include a column with a checkbox for each role that can be deleted. Click in a checkbox to select the corresponding role, click again to deselect.
    Check/Uncheck Buttons
    Check All Click to select all deletable roles in the table (including those on other pages of a paged table).
    Uncheck All Click to unselect all roles in the table (including those on other pages of a paged table).
    Check These N Click to select all deletable roles on the current page of the table. The number N corresponds to the number of roles on the current page (including undeletable ones).
    Only present if table has multiple pages.
    Uncheck These N Click to unselect all roles on the current page of the table. The number N corresponds to the number of roles on the current page (including undeletable ones).
    Only present if table has multiple pages.
  2. Use the checkboxes to select the role or roles that you want to remove.
  3. Click Delete Selected Roles to delete the roles you have selected.

    CodeSonar will delete the roles, then reload the page to show the updated set of roles along with a confirmation message.

Create a New Role

Creating a new role requires G_MANAGE_USERS permission.

In the Create a New Role form, do the following.

  1. Enter a name for the new role in the New Role Name field. Role names must be unique.
  2. Select an existing role from the Controlling Role menu. The available options depend on your permissions.
  3. Click the Create New Role button.

The next steps after creating a new role generally include setting up its relationships and permissions, then assigning it to appropriate users. See RBAC: Roles for a full list of available operations and links to more information.

Navigating from

to Global Role-Permissions Click Global Permissions in the link bar (under the page heading).
to Role Users Click the corresponding row in the table.
to Users Click Users in the link bar (under the page heading).

Related Tasks