Manage Dev Portal Teams
A common scenario for a Dev Portal is to restrict developers’ ability to view or request access to specific API products based on their permissions. Konnect Dev Portal enables administrators to define Role-Based Access Control (RBAC) for teams of developers through the Konnect UI and API.
Portal RBAC supports two different roles for API products that can be applied to a team of developers:
API Viewer: Provides developers with read access to the documentation associated with an API product.
API Consumer: Includes API Viewer permissions as well as allows developers to register applications to consume versions of an API product.
In this guide, you will set up two developer teams and then enable Portal RBAC using a hypothetical scenario.
If you have existing registered developers in Konnect, you must configure developer teams before enabling Portal RBAC. If you enable Portal RBAC before configuring teams for your developers, it will prevent all developers from seeing any API products in your Dev Portal.
We recommend setting up your teams and permissions before enabling RBAC to allow for a seamless transition; developers see what they’re supposed to, instead of nothing at all.
Configure developer teams
In this scenario, you are a product manager at a pizza company, responsible for overseeing their online application. Your task is to create a Dev Portal intended for delivery companies. This portal will grant delivery companies access to your APIs, enabling them to incorporate your pizza offerings into their own delivery service offerings. One of your primary objectives is to ensure that only trusted delivery partners are granted access to develop applications using your APIs and deliver your pizzas.
To achieve this, you must create two groups of developers, each with different levels of API access:
Authorized Delivery Partners: This group can access and consume your APIs so they can integrate them into their own delivery applications.
Prospective Partners: These developers are currently undergoing an evaluation process. Since these potential partners have not completed the evaluation process, you grant them restricted view-only access. This allows them to review the API specs and gain an understanding of how your system operates.
Create an API product
In this scenario, before you can configure developer teams, you must have an API product created. This API product will be for your Pizza Ordering API. This API is used at your pizza company’s website to take orders. Delivery companies can hook into this to see when orders are placed so they can have drivers ready.
Create developer teams
Next, let’s create two developer teams: “Authorized Delivery Partners” with API Viewer and Consumer permissions and “Prospective Partners” with API Consumer permissions.
Enable Portal RBAC
Now that you’ve configured your two different teams and assigned permissions to those teams, you can enable Portal RBAC to let those permissions take affect. Portal RBAC is disabled by default in the Konnect portal.
Now that you’ve completed the steps in this scenario, you have a developer team for vetted, pizza delivery partners that can view and consume your APIs as well as a read-only developer team for unvetted, potential delivery partners. Since Portal RBAC is enabled, those teams can now view your Pizza Ordering APIs.
Portal RBAC API documentation