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 Roles | Privilege |
|---|---|
Organization owner | Add Org Designer Manage Permissions Manage Portal Access Requests Manage Templates Grant or deny access requests for products View or edit the portal settings |
Organization-level designer | Add Portal Product Designer for all resources Create Portal Product Preview product content Create products Search private content. |
Organization-level consumer | Add Portal Product Consumer for all resources |
Project Designer | Edit product content. Publish product content. |
Product-level Designer | Add Portal Product Consumer Provider side access Access assigned products. |
Product-level consumer | Consumer side access Access assigned products. |
PS Admin | Manage Licenses Manage Settings Manage Projects Manage Permissions |
Team Admin | Add users to a team NoteTeam admins can add users to a team, and must be licensed members |
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.