Role Management
Note
This page focuses on role management in API Hub Portal.
Read more about the Swagger and Platform Services user management here.
Role management for API Hub Portal is done inside API Hub for Design. See the API Hub for Design Documentation on how to set up user roles.
API Hub Portal Uses the following types of API Hub for Design 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 API Hub for Design and API Hub for Design are members outside the API Hub for Design 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, API Hub Portal users with a consumer or designer role have access to:
All private products in your portal.
All private APIs in the API Hub for Design organization, both in API Hub for Design and API Hub Portalout.
The designer role in API Hub Portal does not imply the designer access to APIs in API Hub for Design.
Note
Individuals or a team must be assigned designer access to edit public and private products on the provider side of the portal.
API Hub for Design role or roles | Action | Location |
|---|---|---|
Organization owner | Assign product-level or organization-level roles. | API Hub for Design |
Organization owner | Delete portal | API Hub Portal provider view |
Organization owner | Delete product | API Hub Portal provider view |
Organization owner | Grant or deny access requests for products | API Hub Portal provider view (and API Hub for Design) |
Organization owner Organization-level designer | View or edit the portal settings.s Create products | API Hub 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 | API Hub 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 | API Hub Portal consumer view |
No role required | Access landing page | API Hub Portal consumer view |
No role required | View public products (including private APIs that are added to the public product) | API Hub Portal consumer view |
No role required | Search content for public products | API Hub 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.