Predefined roles
Eligible plans: Enterprise
The API Hub for Contract Testing application comes with the following predefined roles. Each role is assigned a collection of permissions.
Administrator
The API Hub for Contract Testing tenant user will be assigned the Administrator role. They can then assign the Administrator role to other users.
Default permissions
User
All new users are assigned the User role (unless the default role has been updated in the system preferences). The User role is intended to work in conjunction with team assignments, and therefore has manage:team permissions (rather than manage:* permissions) for all resources that can be associated with a team. The User role should be assigned to all developers, testers and other users who create and verify contracts on the API Hub for Contract Testing platform.
Default permissions
CI/CD
This is the default role associated with a system account.
Default permissions
Team Administrator
This role is automatically assigned to any user who is an administrator of a specific team. This role may not be edited or deleted and cannot be assigned directly via the user roles APIs or UIs.
Default permissions
Viewer
Default permissions
Guest
A user with the guest role can only view contract related data through the UI and has no API access.
The guest role permissions may not be modified.
Permissions
SwaggerHub
A user with the SwaggerHub role can provide an API Token for the API Hub for Design integration. This allows API Hub for Design to verify published pacts against live OpenAPI descriptions.
The SwaggerHub role permissions may not be modified.
Permissions
SCIM
For the System Account used by the API Hub for Contract Testing SCIM API.
The SCIM role permissions may not be modified.
Permissions
Test Maintainer (deprecated)
The Test Maintainer role has been replaced by the User role. The difference between the User and Test Maintainer roles is that the User role has team scoped permissions for Webhook and Secret management.
Default permissions
Organization Administrator
A system-assigned role for users to administrator authentication and user access within API Hub for Contract Testing. It has no API or contract data access, and does not consume a paid seat.
The Organization Administrator permissions may not be modified and cannot be assigned to users from within API Hub for Contract Testing.
Default permissions:
Resetting permissions for predefined roles
Should you wish to reset the permissions assigned to each of the predefined roles back to their defaults as documented above (or upgrade from the globally scoped User role to the team scoped User role) you can follow these steps. Note that any custom roles will remain unaffected, and user/role assignments are unchanged.
Click on the
APIbutton at the top right of the API Hub for Contract Testing dashboard.In the
Linkssection, scroll down to the line where therelcolumn has a value ofpf:admin-roles.Click on the green arrow in the
GETcolumn with the hover text "Follow link".Scroll up to the top of the page.
In the Links section, if you can see the line with a
relofpf:reset, you have the permissions required to reset the roles. If you cannot see this relation, you do not have the required permissions.Click the yellow
!button in theNON-GETcolumn.Click the blue
Make Requestbutton. You will see a 200 OK response with the updated roles list.