Roles

With Roles, you can define user permissions and manage access according to your Developer Portal’s rules. This allows for greater control, restricting pages as needed.

In Roles you control access to your Developer Portal pages.
User roles for accessing Portal Manager are managed by Access Control.

Accessing the Roles tab

To go to the Roles tab:

In the left side menu, click Settings.
On the screen that opens, click the Roles tab.

roles screen with indications on how to get there

Creating a new role

Follow the steps below to add a role:

Access Settings > Roles.
Click the + NEW ROLE button, located on the right side of the screen.

Fill in the fields and click SAVE. All fields are mandatory.
create role fields

Role name: Define a name for the role with at least 3 characters.
Role description: Describe the role’s restrictions.

Routes: choose one or more routes to define which areas the user can access.
It is necessary to choose at least one of these routes:

Route

Access

API Catalog

Management of products

Apps

Creation and editing of Apps via Developer Portal

Guides

Guides screens

FAQ

FAQ section

API Status

Listing of the API status screen

API Activity Monitor

Call records

Default role

The default role is assigned to new users who register in your Developer Portal when the automatic approval option is enabled in Settings > Developers of your Portal Manager.

When you create the first role, it is automatically set as the default.

To change the default:

In the Default role column of the Roles tab, click the toggle for the role you want to set as default.

highlight for the default role column toggles

A default role cannot be deleted.
To delete, first select another role as default.

Deleting a role

To delete a role:

Access Settings > Roles.
In the ACTIONS column, click the for the role you want to delete.
Confirm the action by clicking DELETE.

deleting a role

The Authenticated and Public roles cannot be deleted.
When a role is deleted, users who had the deleted role will be assigned the default role.

Editing a role

Follow the steps below to edit a role:

In the ACTIONS column of the Roles tab, click the icon.

Make the necessary changes. All fields are mandatory.
Edit Role screen

Role name: Name for the role using at least 3 characters.
Role description: Description with the role’s restrictions.

Routes: Routes that define which areas the user can access.
It is necessary to choose at least one of these routes: