Role Management
Note
This page focuses on role management in Swagger Portal.
Read more about the Swagger and Platform Services user management here.
Role management for Portal is done inside Swagger Studio. See the Swagger Studio Documentation on how to set up user roles.
Portal Uses the following types of Swagger Studio organization-level or product-level roles:
Consumer role. A consumer can access the consumer view only. You need this role if you only want to see the contents of the products without the ability to change the products. This role allows you to access private products on the portal landing page.
Designer role. A designer can access the provider view and the consumer view. You need this role to create and manage your portal landing page and products. Designers also have consumer permissions.
Users are not registered in Swagger Studio are members outside the Swagger Studio organization. These users can only access:
The landing page.
The public products.
Caution
As you set the consumer and designer roles at an organizational level, Swagger Portal users with a consumer or designer role have access to:
All private products in your portal.
All private APIs in the Swagger Studio organization, both in Swagger Studio and Portalout.
The designer role in Portal does not imply the designer access to APIs in Swagger Studio.
Note
Individuals or a team must be assigned designer access to edit public and private products on the provider side of the portal.
Swagger Studio role or roles | Action | Location |
|---|---|---|
Organization owner | Assign product-level or organization-level roles. | Swagger Studio |
Organization owner | Delete portal | Portal provider view |
Organization owner | Delete product | Portal provider view |
Organization owner | Grant or deny access requests for products | Portal provider view (and Swagger Studio) |
Organization owner Organization-level designer | View or edit the portal settings.s Create products | Portal provider view |
Organization owner Organization-level designer Product-level designer (public or private) | View or edit product settings. Preview product content Edit product content Publish product content | Portal provider view |
Organization owner Organization-level consumer or organization-level designer Product-level consumer or product-level designer (only assigned product or products) | View private products Search private content | Portal consumer view |
No role required | Access landing page | Portal consumer view |
No role required | View public products (including private APIs that are added to the public product) | Portal consumer view |
No role required | Search content for public products | Portal consumer view |
Important
Users with the designer role for a product (Individual or team) must also be assigned the consumer role or higher on any API or project containing the exact product's APIs.