Define roles and permissions within Postman
Certain team options are only available with paid plans. To learn which roles are available with your plan, go to your web dashboard.
Roles define user permissions within Postman and levels of access to a Postman element, like a collection or an API.
Organization roles
Postman Organizations is available with Postman Enterprise plans.
Each team within an organization has its own set of independent roles:
Note
- Only a Team Member can create workspaces in the team.
- Sharing an element with a new user triggers the process of adding that user to the Team’s user list.
- Any time a Team Member or Collaborator is removed from the Team’s user list, they lose access to everything in the Team (until they’re added back).
Team roles
With the Admin role, you have the power to define Postman access at the team level. You can use Postman’s role-based access control system to limit visibility of team resources, define your development workflow, and give access to administrative and billing personnel. Each user on a team must have at least one role attached to them, and can hold multiple roles simultaneously.
You can assign one or more role types to team members, based on the functions those team members require:
- Super Admin (Enterprise plans only) - Manages everything within a team, including team settings, members, roles, and resources. This role can view and manage all elements in internal and public workspaces. Super Admins can perform all actions that other roles can perform. For information on assigning this role, see Manage Super Admins.
- Admin - Manages team members and team settings. Can also view monitor metadata and pause and resume monitors.
- Billing - Manages team plan and payments. Billing roles can be granted by a Super Admin, Admin, or by a fellow team member with a Billing role.
- Developer - Has access to all team resources and workspaces.
- Community Manager (Professional and Enterprise plans only) - Manages the public visibility of workspaces and team profile.
- Partner Manager (Internal, Enterprise plans only) - Manages all Partner Workspaces within an organization. Controls Partner Workspace settings and visibility, and can invite, remove, and manage partners. To learn more, see Partner team and Partner Workspace roles.
- Partner (External, Professional and Enterprise plans only) - All partners are automatically granted the Partner role at the team level. Partners can only access the Partner Workspaces they’ve been invited to. To learn more, see Partner team and Partner Workspace roles.
- Guest (Internal) - Views collections and sends requests in collections that have been shared with them. This role can’t be directly assigned to a user. To learn more, see Share collections with guest users.
If you are on a Postman Enterprise plan, you can also assign roles at the group level.
Team roles offer high-level access control:
There are additional specialized roles for Enterprise teams:
- API Network Manager - Manages a team’s Private API Network. To learn more, see Network roles.
- API Governance Manager - Manages API governance within a team, including governance rules, functions, and workspace groups.
* On Basic and Free plans, any developer can change the visibility of workspaces.
** On Enterprise and Professional plans, only Super Admins and Community Managers can change and approve requests to change the visibility of a workspace to internal or public.
*** Enterprise plans only. Teams can allow users with the Folder Manager role to manage elements in specific folders in your team’s Private API Network.
Important
Team members with a Developer or Super Admin role consume a paid seat on your team. Team members who have only Admin or Billing roles become support users and don’t consume paid seats. Each team can have two support users.
Managing team roles
To learn how to manage team roles in Postman, see Manage your team.
Workspace roles
You can assign three role types in Postman workspaces: Admin, Editor, and Viewer. Partner Workspaces offer an additional role type: Partner Lead.
- Admin - Can manage workspace resources and settings.
- Editor (Professional and Enterprise plans only) - Can create and edit workspace resources.
- Viewer (Professional and Enterprise plans only) - Can view, fork, and export workspace resources.
- Partner Lead (External, Enterprise plans only) - Can invite other partners from their organization to join a Partner Workspace. To learn more, see Partner team and Partner Workspace roles.
Partners have different permissions for Workspace Editor and Viewer roles in Partner Workspaces (Enterprise plans only). To learn more, see Partner team and Partner Workspace roles.
You can use the Postman API to programmatically manage users and user groups for workspaces. For more information, see the Postman API collection.
The following roles control access at a workspace level:
* Workspace Editors can’t move or delete any API. They must have the API Admin role on APIs they want to move or delete.
** On Professional and Enterprise plans, an Admin for a workspace must request to change its visibility to public. This request will go to the Community Manager. On Basic and Free plans, or if a team has no Community Manager assigned, an Admin for a workspace can control its visibility.
Element-based roles
At the element level, you can assign roles to team members that decide their level of access to the following elements:
Collection roles
You can assign two role types in Postman collections: Editor and Viewer.
- Editor - Can edit collections directly
- Viewer - Can view, fork, and export collections
Partners have different permissions for Collection Editor and Viewer roles in Partner Workspaces (Enterprise plans only). To learn more, see Partner team and Partner Workspace roles.
You can assign a limited Viewer role to a coworker who isn’t in your Postman team by allowing them to view specific collections. Users with this role can only view specific collections and send requests in the collections that have been shared with them.
The following roles control access at a collection level:
API roles
You can assign three role types in Postman APIs: Admin, Editor, and Viewer.
- Admin - Can publish, move, and delete APIs
- Editor - Can edit APIs and API definitions
- Viewer - Can view published API versions
If you have the Workspace Admin role, you will automatically inherit Admin permissions for all APIs in the workspace, even if you are assigned the Editor or Viewer role for an API.
The following roles control access at an API level:
* API Editors can assign users the Viewer or Editor role. API Editors can’t assign a user the Admin role, or change an Admin to an Editor or Viewer.
Environment roles
You can assign two role types for Postman environments: Editor and Viewer.
- Editor - Can edit and manage environments
- Viewer - Can view and use environments
The following roles control access at an environment level:
Mock server roles
You can assign two role types for Postman mock servers: Editor and Viewer.
- Editor - Can edit and manage mock servers
- Viewer - Can view mock servers and associated metadata
The following roles control access at the mock server level:
Monitor roles
You can assign two role types for Postman Monitors: Editor and Viewer.
- Editor - Can view monitor metadata, metrics, jobs, and runs. Can also run, update, delete, pause, and resume the monitor.
- Viewer - Can view monitor metadata, metrics, jobs, and runs.
Partner team and Partner Workspace roles
Partner team and Partner Workspace roles relate to Partner Workspaces and are applied at the team, workspace, and collection levels. There are different team and Partner Workspace roles you can assign to team members and external partners:
You can assign the Partner Manager role to team members at the team level, and invite partners with the Partner role:
- Partner Manager - Manages all Partner Workspaces within an organization. Controls Partner Workspace settings and visibility, and can send invites to partners. If no Partner Manager role is assigned, the Admin is auto-assigned the Partner Manager role when they create their first Partner Workspace.
- Partner - Can only access the Partner Workspaces they’ve been invited to. All partners are assigned Workspace Editor or Viewer roles when invited to a Partner Workspace. You can edit Partner Workspace permissions for partners at the workspace and collection levels.
You can assign Partner Workspace roles to partners at the workspace level:
- Partner Lead - Can invite other partners from their organization to join a Partner Workspace.
- Editor - Partners can create and edit Partner Workspace resources, import and export elements, and fork elements to Partner Workspaces within the same team.
- Viewer - Partners can view Partner Workspace resources and fork elements to another Partner Workspace within the same team where they’re assigned the Workspace Editor role.
You can also assign Partner Workspace roles to partners at the collection level:
- Editor - Partners can export collections. They can also fork collections within the same Partner Workspace or to another Partner Workspace within the same team. They can’t fork collections outside the team.
- Viewer - Partners can fork collections to another Partner Workspace within the same team where they’re assigned the Workspace Editor role. They can’t fork elements outside the team. Also, they can’t export collections.
To learn more about collaborating as a team member or partner, see Collaborate in a Partner Workspace.
Your team must have available seats or Auto-Flex enabled to invite a partner as a Workspace Editor. Otherwise, the partner will be assigned the Workspace Viewer role, giving the partner permission to view all workspace resources. Also, your team must have available seats to assign a partner as a Collection Editor. Assigning a partner the Workspace Viewer or Collection Viewer roles doesn’t consume paid seats.
Network roles
Network roles related to your Private API Network are applied at the team and folder level.
You can assign network roles at the team level:
- API Network Manager - Manages a team’s Private API Network, including adding elements and reviewing requests to add them.
You can also assign network roles at the folder level:
- Folder Manager - Manages specific folders and the elements in them in a team’s Private API Network. Team members with this role can perform all actions that API Network Manager role can perform but only in folders they have permission to manage.
Next steps
After learning about the roles available to team members, you can manage your team’s level of access and control more effectively.
- To learn more about team management, including managing team roles and inviting collaborators to join your team, visit the Team management overview.