Swagger Product Specific Roles and Permissions

This page provides an overview of roles and permissions for each Swagger product, including Portal, Studio, Explore, Contract Testing, and Functional Testing. It details how administrators can manage user access and responsibilities. Each Swagger product 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.

Swagger Studio

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

Table 1. Studio 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 the Swagger Studio 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.

  • View APIs and domains, and comment if this option is enabled in the organization.



Swagger Portal

Portal leverages Swagger Studio 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 2.  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.



Swagger Explore

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

Swagger Contract Testing

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

Table 3.  Contract Testing Roles and Permissions

Roles

Permissions

Administrator

Update all resources, such as webhooks, secrets, teams, roles, user assignments, environments, and so on, in the Contract Testing workspace. Also has access to all contract data.

Organization Administrator

Manage users, teams, and role assignments in the 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.

Studio

Read-only role for the API Swagger Studio integration. Intended for use with the Swagger Studio toolset.

SCIM

The system account is used exclusively for SCIM API operations (provisioning, user sync) and is not intended for users.



Swagger Functional Testing

Functional Testing 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 Functional Testing documentation for more information on Account Setup.

Table 4. Functional Testing 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

  • The manager can modify the account integrations and manage tests.

  • Manage the non-administrator users of the account.



Publication date: