1. Home
  2. ...
  3. Settings
  4. Roles

Roles

Understand how to create, edit, and manage roles and access permissions in the Developer Portal.

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.

NOTE

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:

Step 1

In the left side menu, click Settings.

Step 2

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:

Step 2

Click the + NEW ROLE button, located on the right side of the screen.

settings tab with new role button highlighted

Step 3

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 CatalogManagement of products
AppsCreation and editing of Apps via Developer Portal
GuidesGuides screens
FAQFAQ section
API StatusListing of the API status screen
API Activity MonitorCall 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.

Step 1

To change the default:

Step 2

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

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

Deleting a role

To delete a role:

Step 2

In the ACTIONS column, click the trash can icon for the role you want to delete.

Step 3

Confirm the action by clicking DELETE.

deleting a role

NOTE
  • 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:

Step 1

In the ACTIONS column of the Roles tab, click the pencil icon representing the edit action icon.

Step 2

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:
Route
Access
API CatalogManagement of products
AppsCreation and editing of Apps via Developer Portal
GuidesGuides screens
FAQFAQ section
API StatusListing of the API status screen
API Activity MonitorCall records

Assigning a role to an existing user

To assign a role to an existing user:

Step 1

Access the Consumers > Developers page by clicking the card on your Portal Manager home page or in the left side menu:

home screen with developers option highlighted

Step 2

Locate the desired user.

Step 3

In the ACTIONS column, click the pencil icon representing the edit action icon.

Step 4

Choose one or more roles for the user and click SAVE to save.

screen to edit a developer's access

TIP

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more