Roles Management


This page allows you to create and define roles that users can be assigned to for defining his/her access to the system.

The Roles Management page

Before You Begin

Make sure the Roles Management page is open and the currently logged-in user has the right permissions to make changes to users in the platform.

About the Task

This is how one associates a user to a specific role in the system. It is here where one defines which API call(s) the role has access to and whether or not the role can view, execute and/or edit the API call(s).

Procedure to Create a Role

  1. Click the "+ Create" button on the upper right-hand side of the page. 

  2. In the pop-up box which opens, enter a "Name" for the role as well as an optional description to accompany the name of the role. They cannot be changed.

  3. Click the "Save" button on the bottom of the pop-up. The role appears on the Roles Management page. 

Procedure to Search for a Role

  1. On the "Roles Management" page at the upper left-hand side, start typing in the "Filter" box the name of the role you are searching for. 

  2. Confirm the new (or existing) role is listed after the filter has been applied. You can sort the roles you've created by name or description.

Procedure to Edit a Role

  1. Under the "Actions" column on the right, click on the three vertical dots to choose the action you are looking to perform.

Actions include:

  1. Permissions - This allows you to make specific permission changes to the currently selected role.

  2. Delete - This will remove the role from the system.