User Management
User management for SwaggerHub Portal is done inside SwaggerHub. See the SwaggerHub Documentation on how to set up user roles.
SwaggerHub Portal uses the following types of SwaggerHub 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 also allows you to access the private products on the respective 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 not registered in SwaggerHub and SwaggerHub members outside the SwaggerHub 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, SwaggerHub Portal users with a consumer or designer role have access to:
All private products in your portal.
All private APIs in the SwaggerHub organization, both in SwaggerHub and SwaggerHub Portal.
The designer role in SwaggerHub Portal does not imply the designer access to APIs in SwaggerHub.
Note
Individuals or a team must be assigned designer access to edit public and private products on the provider side of the portal.
SwaggerHub role or roles | Action | Location |
|---|---|---|
Organization owner | Assign product-level or organization-level roles | SwaggerHub |
Organization owner | Delete portal | SwaggerHub Portal provider view |
Organization owner | Delete product | SwaggerHub Portal provider view |
Organization owner | Grant or deny access requests for products | SwaggerHub Portal provider view (and SwaggerHub) |
Organization owner Organization-level designer | View or edit portal settings Create products | SwaggerHub 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 | SwaggerHub 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 | SwaggerHub Portal consumer view |
No role required | Access landing page | SwaggerHub Portal consumer view |
No role required | View public products (including private APIs that are added to the public product) | SwaggerHub Portal consumer view |
No role required | Search content for public products | SwaggerHub 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 that contains the APIs for that same product.