Organizations, Projects, and Teams

Last modified on October 20, 2021

In SwaggerHub, organizations simplify managing group-owned API definitions and let you develop and publish your APIs under the organization namespace. Each organization contains a collection of public and private APIs and domains.

You can see all your organizations in the sidebar of My Hub:

Organizations in SwaggerHub

Click the image to enlarge it.

Create and manage organizations

Organization-specific features

Teams

Organization owners can create teams to group members logically and to control access to definitions and projects. See Teams for more information.

Organization settings

Only organization owners can see and change the organization settings.

To open the organization settings, go to My Hub and click next to the organization name in the sidebar.

Accessing SwaggerHub organization settings

Click the image to enlarge it.

In earlier SwaggerHub On-Premise versions, the organization settings button is in the header area on the right.

Accessing SwaggerHub organization settings

Click the image to enlarge it.

Organization settings are organized into several pages:

  • Overview – your plan limits and usage. Here you can also download the audit log, rename or delete the organization.

  • Members – invite new members, change member roles, or delete existing members.

  • Teams – create or delete teams, manage team members.

  • Standardization – configure API standardization rules for all APIs in your SwaggerHub organization.

  • Docs Branding – add custom branding to your API documentation.

  • Plan – view your plan details, change your plan, or cancel it.

  • Billing – view the date and sum of the next payment, review the billing history, download PDF invoices.

  • Payment Method – view or change your billing information and the credit card used for payments.

Create APIs and domains under the organization

To create an API or domain on behalf of an organization, select the organization as the Owner of this API or domain. By default, Owners and Designers can create APIs under the organization, but this can be limited to just the Owners.

Creating an API in the organization namespace

Click the image to enlarge it.

Member roles and permissions

You can have one of the following roles in an organization: Owner, Designer, or Consumer. Each role has specific permissions. You can see your role in the header of the organization catalog page:

Member role
Note: By default, Designers have View access to the organization’s APIs and domains created by other Designers. To get Edit access, a Designer needs to be added as a collaborator on an API or domain. Collaborator permissions can be granted to individual members, as well as teams.

Projects

Organization owners can go further and group the organization’s APIs and domains into projects. This will structure the APIs and domains logically, provide easier access to them and simplify management. Project members can see the projects in the sidebar on the left:

Swagger APIs in SwaggerHub: Organizations and projects

Click the image to enlarge it.

An API or domain can belong to multiple projects.

What APIs and domains are visible

By default, all the members can see all of the organization’s APIs and domains – both public and private. This behavior is controlled by the Allow Designers and Consumers to view all the Organization’s Private APIs option in the organization settings. If this option is disabled, Owners can see everything, while Designers and Consumers can see only public APIs and domains.

Allow Designers and Consumers to view all the Organization’s Private APIs

Click the image to enlarge it.

Note that project members can see both public and private definitions in that project, regardless of the organization settings.

Swagger APIs in SwaggerHub: Default project view - Public APIs and domains

Click the image to enlarge it.

Another way to grant access to private APIs and domains is to add specific users as collaborators on these APIs and domains.

Organization owners can also create teams to group members logically and to control access to definitions and projects easier.

Billing

Organizations are billed separately from personal accounts. Every organization requires a paid plan based on the number of users and features you want to use. New organizations start with a free 14-day trial, no credit card is required. After the trial period expires, choose a plan that best suits your organization needs.

See also:

See Also

Collaboration

Watch the video
 
Highlight search results