Roles

Roles are a set of access permissions for the components of the platform. The components can have 2 type of accesses: Read Only and Full.

The read only access, as the name suggest is for view permissions of the assets in the component, and Full access allows user to create, modify and administer the assets.

Any asset created by the user is owned by that user and user automatically assumes the role of “Administrator” to the created asset. The asset administrator can give permissions to any other user and the permission can be of Read, Modify or Administrator level.

Any user who has Administrator level permission has same access levels as the owner or creator of the asset. Any Administrator for the asset can add or remove users and change access permissions from any level to any other level. It is therefore advisable to grant an Administrator permission only if it’s required.

There are 5 pre-configured roles and these cannot be modified:

• Administrator: This is the administrator role and it has same access as the administrator who is creating the user. It is advisable that this role is assigned to the right users since this role has maximum access to add, change or delete users, groups, roles and assets on the platform. 

• Designer: This role is intended for the users that will act as API designers. This role includes permissions on following components:
• Access Manager: None
• API Design Studio: Full
• API Validator: Read Only
• API Manager: None
• Portal Manager: None
• API Products: Read Only
• API Insights: Read Only
• Developer Studio: None
• Mock Data: Full

• Developer: This role is intended for the users that will act as internal API developers. This role includes permissions on following components:
• Access Manager: None
• API Design Studio: Read Only
• API Validator: Full
• API Manager: None
• Portal Manager: None
• API Products: Read Only
• API Insights: None
• Developer Studio: Full
• Mock Data: Full

• Product_Manager: This role is intended for the users that will act as API product managers. This role includes permissions on following components:
• Access Manager: None
• API Design Studio: Read Only
• API Validator: Full
• API Manager: Read Only
• Portal Manager: Read Only
• API Products: Full
• API Insights: Full
• Developer Studio: None
• Mock Data: Full

• api_user: This role is intended for the users that will act as API users or consumers. This role includes permissions on following components:
• Access Manager: None
• API Design Studio: None
• API Validator: None
• API Manager: None
• Portal Manager: None
• API Products: Read Only
• API Insights: None
• Developer Studio: None
• Mock Data: None

New roles can be created if none of these suit for the requirement. The new created roles can be modified at anytime. Do note that the roles are applied after modifications and any changes done by users prior to modifications will remain.

To create a new role, log into the platform and select “Access Manager”. Select “Role” from the left menu. The right side panel shows option to create new role on the upper side of the screen. Specify the name of the role and select the permissions from the table. If none of the radio buttons are selected, then the role would not have any permission not the component. Selecting “Read Only” or “Full” permissions will enable the role for the selected access.

The roles can be searched based on the criteria selected in the search part of the screen.

The role name does not need to be complete and any partial role name will be appended on both sides with wildcards for searching. For example, searching with a text “abc” will search all roles that has “abc” in their names. From the permissions search fields, if none of the permissions for any component is selected, the role with either Read Only or Full access will be searched. However if any of the access levels are selected, the search will filter results to include only the selected criteria for the role. To illustrate, if you want to search for all roles that have Full access to API Design Studio, just select the column “API Design Studio” and row “Full”. If you want to limit search to look for roles that have Full access to “API Design Studio” and Full access to Portal Manager, select the row “Full” for both columns “API Design Studio” and “Portal Manager”.

The created roles can be modified. Search for the roles you want to modify and click on “Edit” button in last column of the same row as role. It will open a dialog box with selected permissions for the role which can be edited. Clicking on “Clear” will clear all the boxes. This might be needed if you are looking to entire remove permissions from one or some of the components.

The changes are saved only when OK button is clicked on the dialog box.