Creating an Organization

Last modified on October 20, 2021

You can create organizations in SwaggerHub to add API definitions on behalf of an organization.

Notes:

  • 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.

  • SwaggerHub On-Premise 1.19.2 and later have a concept of a default organization. The default organization is created automatically during installation or upgrade.

To create a new organization:

  1. In the sidebar on the left, click and select Create New Organization:

    Creating an organization in SwaggerHub
  2. Enter organization details:

    Organization details
    • Organization Account Name – Required. A unique ID for your organization. The organization’s APIs will live under https://app.swaggerhub.com/apis/orgname.

      Requirements:

      • 3 to 20 character long
      • Allowed characters: A..Z a..z 0..9 - _ .
      • Case-insensitive
    • Organization Email – Required. This will be your organization’s default billing email unless you specify a different email in the billing details later. This email address will also be used if we ever need to contact your organization.

    • Title – An optional organization title. For example, Acme Inc.

    Note: All these values can be changed later in the organization settings.
  3. Click Add Organization.

Once an organization is created the trial period begins, during which the organization can use all of the features provided by the assigned plan. You can see the plan limits and the remaining trial days in Account Settings > My Organizations > Billing. There you can also activate a permanent subscription for the organization. The trial period or paid subscription will be canceled if you delete the organization.

What’s next

Organization-level permissions

  • For the users to see the organization’s private APIs, the Allow Designers and Consumers to view all the Organization’s Private APIs option must be selected in organization preferences.

  • For Designers to be able to create new APIs in the organization, the Allow Designers to Create APIs under the Organization option must be selected in organization preferences.

  • For Designers to be able to edit existing APIs, these users must be added as collaborators to the individual APIs.

See Member Roles and Permissions for more information about organization-level permissions.

See Also

Organization Ownership
Teams
Collaboration
Deleting an Organization

Highlight search results