Work with Others
This page introduces API Hub for Design's access control and sharing. To complete the steps in this tutorial, you need to be an organization owner.
Overview
An organization in is the collection of members and resources linked to an account.
In API Hub for Design, each organization has one or more owners who manage teams and resource access.
In SmartBear Admin, each organization has assigned administrators, who can invite members and manage subscription plans.
Below are the types of resource files:
API definition files
Domains (shared libraries of API components)
API Custom Templates (API definitions that can be used as a basis for new APIs)
Portal products
APIs and domains can be grouped into:
Projects (folders) or accessed individually.
API Hub for Design lets you share resources and projects within your organization. You control access by assigning user roles:
Designers have full access to all features of designing and testing API definition files.
Owners are a special type of designer who can also manage teams, projects, and template files.
Consumers can review API definition files and optionally comment.
To manage access, you can group users into:
Teams of members who work on the same set of resources.
The owner of an organization can:
Manage user roles within 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.
Designers can:
Create and update APIs and domains, configure Codegen options, generate client and server code.
Share resources with members and teams.
Consumers can:
Review APIs and domains.
Comment (if allowed).
Collaborators
Collaborators are a special category of users that organizations count separately. They are unlicensed users who have access only to individual resources. You must invite collaborators directly to specific resources. Depending on their assigned role, collaborators can act as designers or consumers.
Administrator in SmartBear Admin
A separate user role available in SmartBear Admin is an administrator.
Within SmartBear Admin, administrators can:
Manage organizations' plans
Invite or remove organization members
Manage member licenses
It is not necessary to have a API Hub for Design license to be an administrator.
A user with administrator privileges in SmartBear Admin can at the same time be an owner or a designer within API Hub for Design. Alternatively, an administrator may have no role assigned in API Hub for Design.
Regardless of their role assignment, administrators can do the following actions within API Hub for Design:
Manage user roles within an organization
Manage teams of users
Create and manage projects (groups of resources), including access by individual members and teams
Add members to your organization
The next step in working with others is to add users as organization members. To do that, you need administrator privileges.
Click Organization Settings at the bottom of the sidebar. Switch to the Members tab and click Manage Members to invite users to your organization. You will be redirected to SmartBear Admin page. For more details on how to navigate it, click here.
Create teams and add team members
Teams allows you to group members to collectively work on APIs. In any organization, you can create teams on the Teams tab of the Organization Settings screen.
To learn about organizations and teams in detail, check out our documentation.
Important
When a team is assigned access to a resource, EVERY member of the team is assigned that same access role. So if a team is set to be a designer of a resource, every team member also becomes a designer. If there are insufficient designer license seats available you will not be able to grant the role change to the team.
We have now successfully created an organization, added members, and added members to teams.
Create projects
Resources in API Hub for Design (API definitions, domains, templates, Portal products) can be grouped into folders called projects. This is an optional step for organizing your content and managing user access. Projects are displayed on the main screen under the name of your organization.
To create a project, click Create New in the sidebar on the left and select Create New Project. Specify the Project Name (unique ID), and optionally Project Description. You will then have the option of selecting resources and inviting teams/members to your project.
Create resources
To create resources:
Click Create New in the left sidebar.
Select the type of resource you want to create:
API
Template
Domain
Choose an owner for the resource - this step is required for all resource types.
For detailed instructions on resource creation, see the Manage APIs page.
Note
Only organization owners can create API custom templates.
Invite members and teams to view/edit your resources and projects
Once a resource is created, from the API Hub for Design editor, owners can add members or teams to work on that resource.
Share an individual resource
In the top right corner of the editor, click the Share icon 
>
, and then select Collaboration to invite members or teams to work with this resource.
You can also share resources on the Catalog pages.
Share a project
The Home sidebar displays the projects you have access to under the organization names.
Click the Settings icon 
to the right of the project name to invite a member or team to a project.