Get started with Insomnia Enterprise

If you’re new to Insomnia Enterprise, this document will guide you through the full setup of your instance in Insomnia Admin.

Once you’ve signed up for the Insomnia Enterprise plan through the sales team, you’ll get an activation code. The first thing you’ll need to do is:

1. In the Insomnia Admin app, click Upgrade.
2. On the Change subscription plan page, select the Enterprise plan.
3. Enter your activation code.

4. Click Verify activation code.

   Once this is done, you’ll be the owner of the Enterprise instance and have access to all the Enterprise features.

5. Click your email address in the header and make sure that your Enterprise instance is selected.
6. Click Enterprise Controls to access your Enterprise configuration options.

By default, your account is created with an organization named Personal Workspace. You can invite users to that organization, but you can also create other organizations to manage access to projects. Let’s take the example of KongAir: the airline might have a Cargo organization and a Passengers organization, with different projects accessible to different users and teams.

1. In the Insomnia Admin app, navigate to your Insomnia account dropdown menu and click Your organizations.
2. Click New organization.
3. In the Organization name field, enter a name for your organization.
4. Click Create organization.

You can add individual users to organizations, but you can also create teams and link them to organizations. This allows you to manage users more efficiently instead of having to invite each user to each organization manually.

Using the KongAir example, you could create:

• A Flight team which has access to both organizations
• A Sales team which only has access to the Passengers organization

You can either create teams manually, or through your SCIM provider. Manually created teams can be synchronized with SCIM teams.

To create teams manually:

1. In your Insomnia account dropdown menu, click Enterprise Controls.
2. In the sidebar, click Teams.
3. Click Create Team.
4. In the Team name field, enter a team name.
5. In the Description field, enter a team description.
6. Click Create team.
7. Click the team you just created.
8. Click the + button for the Org links to link one or more organizations to the team.

Each time a new member is added to the team, they will automatically have access to the linked organizations.

New users can be invited to your Enterprise instance in three different ways:

• Manually through an organization
• Manually through a team
• Automatically with SCIM

Notes:

• Each pending invitation uses a seat in your instance.
• An invitation expires after 30 days. Once an invitation expires, the corresponding seat is open.
• When you remove a user from an org or team, you must also remove them from the Licenses page to free the seat, even if the user was removed from all organizations and teams in the instance.

Invite a user to an organization

1. In your Insomnia account dropdown menu, click Your organizations.
2. Click the org that you want to invite users to.
3. In the Invite field, enter the users’ email addresses.
4. Click Invite.

By default, users are added with the Member role, but you can change their role to Admin if needed. Once the users accept the invitation, they will have access to the content in the selected organization.

Invite a user to a team

1. In your Insomnia account dropdown menu, click Enterprise Controls.
2. In the sidebar, click Teams.
3. Click the team you want to invite users to.
4. In the Invite new members field, enter the users’ email addresses.
5. Select a role from the dropdown menu.
6. Click Invite.

Once the users accept the invitation, they will have access to the organizations linked to their team.

Adding a domain allows you to automatically manage users with email addresses in that domain. It’s also a prerequisite for SSO and SCIM.

1. In your Insomnia account dropdown menu, click Enterprise Controls.
2. In the sidebar, click Domains.
3. Click New Domain.
4. From the Verify using settings, select how you want to verify your domain:
   • Unique verification record: This is the option to use for most domains.
   • Root domain verification record: You can this option to reuse the existing verification record of a root domain to verify a subdomain. For example, if you have already verified the example.com domain, you can use this option to verify app.example.com without having to add a new record to your DNS.
5. In the Domain field, enter your domain.
6. Click Create Domain. If you selected Root domain verification record, the domain will be verified automatically.
7. If you selected Unique verification record, Insomnia provides a TXT record that you’ll need to add to your DNS tool to verify the domain. Once you’ve added the record to your DNS tool, click the checkbox to confirm that it’s done, and click Verify Domain.

Once your domain is created, you can click it to access its settings. For more details, see Add domains.

Once your domain is verified, you can set up SSO with SAML 2.0 or OIDC with your preferred provider.

See our how-to guides to learn how to configure SSO for Insomnia with:

• Okta SAML
• Okta OpenID Connect
• Azure SAML

Once you’ve configured SSO, you can use the same provider to set up SCIM.

See our how-to guides to learn how to configure SCIM for Insomnia with:

• Okta SAML
• Azure SAML

Insomnia allows you to have control over the storage options used in your instance. You can define whether users can use Cloud Sync, Local Vault, or Git Sync storage, or a combination of these.

This allows you to completely control where your proprietary code and data are, and what servers they touch.

1. In your Insomnia account dropdown menu, click Enterprise Controls.
2. In the sidebar, click Storage.
3. Click the Edit icon for your personal workspaces and organizations.
4. Select the storage options you want to allow.
5. Click Save.

Now that your Insomnia Enterprise instance is configured, you and your collaborators can start using the Insomnia app to design and test your APIs. If you are migrating from another tool, such as Postman, you can import your content:

• Import and export reference for Insomnia
• Migrate collections and environments from Postman to Insomnia
• v11.6+ Import content from Postman to multiple Insomnia projects
• Import an API specification as a design document in Insomnia