API Hub Feature-Specific Roles and Permissions

This page provides an overview of roles and permissions for each API Hub feature, including API Hub for Portal, Design, Explore, Contract Testing, and Test. It details how administrators can manage user access and responsibilities. Each feature has unique role-based access controls (RBAC). Links to relevant documentation are included for in-depth guidance.

The following roles and permissions in the solution interface can be set and managed. Refer to Adding and Managing Users for more information.

API Hub for Design

API Hub for Design offers a robust user management framework for user permissions. Users can hold multiple roles across different levels and resources. Refer to the API Hub for Design documentation for resource sharing and Resource Roles.

Table 3. Design Roles and Permissions

Role	Role Permissions
Owner	Manage user roles in an organization. Manage teams of users. Create and manage projects (groups of resources), including access by individual members and teams. Create and manage API custom templates. Create standardization rules. Invite members and manage plans.
Admin	Manage organization plans. Invite or remove organization members. Manage member licenses. For more information on Administrator in SmartBear Admin, refer to the Work with Others topic in API Hub for Design documentation.
Designer	Create and update APIs and domains. Configure Codegen options and generate client and server code. Designers cannot manage user roles in an organization. Manage teams only if the designer is a Team administrator.
Consumer	Review APIs and domains. Consumers can view APIs and domains, and comment, if the option is enabled in the organization.

API Hub for Portal

API Hub for Portal leverages API Hub for Design user management controls to streamline the admin experience with Available Portal-Specific role assignments. Refer to Role Management for more information on various roles and access.

Table 4. Portal User Roles and Permissions

Role	Role Permissions
Organization-level owner	Assign roles. Delete products and portals. Use the “access requests” feature. All designer permissions.
Organization-level designer (or owner)	Edit and publish content in all products. Create products. All consumer permissions.
Organization-level consumer	View all private products.
Portal Product Designer	Edit and publish content in a product. Edit products for which they have the required permissions and access.
Portal Product Consumer	View the product for which they have the required access and permission.
No role required	Access the landing page, view, and search public products.

API Hub for Explore

API Hub for Explore does not include any predefined user roles or permissions. In API Hub for Explore, permissions can be set at the project level. Refer to Managing Your Account.

API Hub for Contract Testing

Contract Testing includes predefined roles and supports customizable roles to meet organizational needs. Permissions are managed in the admin section of API Hub for Contract Testing. Refer to the API Hub for Contract Testing documentation for more information on Permissions and Predefined roles.

Table 5. Contract Testing Roles and Permissions

Roles	Permissions
Administrator	Update all resources such as webhooks, secrets, teams, roles, user assignments, environments, and so on in API Hub for Contract Testing workspace. Also has access to all contract data.
Organization Administrator	Manage users, teams, and role assignments in the API Hub for Contract Testing workspace. Access to SmartBear Admin does not have API or contract data access.
Team Administrator	Manage team-level settings and memberships.
User	The default role for new users (unless customized in system preferences). Can view and manage contracts and other resources in the assigned teams. Applicable for developers, testers, and other users involved in contract creation and verification. Refer to Users for more information on user roles and capabilities.
CI/CD	Used by automation systems that query or publish contract data through CI/CD pipelines. Typically assigned to service accounts.
Viewer	Read-only access to contract-related data.
Guest	User Interface (UI) read-only role. Cannot access the API or modify data. Guests can view contract-related data only on the UI.
API Hub for Design	Read-only role for the API Design integration. Intended for use with the Design toolset.
SCIM	The system account is used exclusively for SCIM API operations (provisioning, user sync) and is not intended for users.

API Hub for Test

API Hub for Test allows administrators to assign user roles to control access and permissions. Permissions are managed directly in the feature's admin pages, ensuring users have the appropriate level of access for their tasks. Refer to the API Hub for Testdocumentation for more information on Account Setup.

Table 6. Test Roles and Permissions

Roles	Permissions
Read-Only	Read-only users can view test results and receive email notifications, but cannot create, edit, or delete tests.
Editor	This is for users who create and run tests and suites. Editors can also create and modify variables.
Administrator	Administrators can manage the account subscription plan, view the invoice history, edit the current payment method, and manage other Administrator users.
Manager	Manager can modify the account integrations and manage tests. Manage the non-administrator users of the account.

In this section: