Getting Started With SwaggerHub On-Premise

Last modified on November 28, 2022

After you activate the license and configure your SwaggerHub On-Premise instance, you can access the main application by pointing your browser to the public domain name or IP address of the VM:

http(s)://{domain_or_ip}

Please contact your SmartBear representative about setting up an on-boarding session for your team. In the meantime, here is some information to help your team get started.

Create an organization and invite users

SwaggerHub On-Premise v. 1.19.2 and later

During the SwaggerHub On-Premise setup, you configured the default organization. All new users who sign up or log in to SwaggerHub via SSO for the first time will automatically join the default organization as Consumers.

You can also log in to SwaggerHub and invite users to your organization manually.

SwaggerHub On-Premise v. 1.19.1 and earlier

Follow these steps to create an organization and invite members:

  1. Open the SwaggerHub home page and log in as the admin user, or sign up for a new account.

  2. Once you log in, click Create New and select Create New Organization.

  3. Enter a name for your organization and click Add Organization.

  4. Invite users to your organization:

    • Click your username in the top right corner, select Settings and switch to the My Organizations tab.

    • Click the Manage Users button next to your organization.

    • Here you can invite users by email.

    Note: The invited users will automatically join the organization they were invited to as Consumers when they sign up or log in to SwaggerHub. Non-invited users can sign up or log in to SwaggerHub, but can be invited to an organization by their username or email later.
Note: An SMTP server must be configured for the invites to be sent. See Configuring SMTP Server.

See Adding and Deleting Users in Organizations for more information.

Learn more about organizations, projects, and teams

SwaggerHub includes powerful features to manage multiple organizations, projects, and team collaboration. To learn more about these features, please see Organizations, Projects, and Teams.

Other help resources

The following help resources may be useful:

See Also

Configuring SwaggerHub On-Premise

Highlight search results