OIDC (#253)

* oidc sso Docs on OIDC SSO added to the EE SSO doc. * fix images and navigation --------- Co-authored-by: Filipe Freire <[email protected]>
Kong · Feb 12, 2025 · 28b6ec5 · 28b6ec5
1 parent fc0c4c4
commit 28b6ec5
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 5 deletions.
diff --git a/docs/_data/main-nav.yaml b/docs/_data/main-nav.yaml
@@ -37,6 +37,8 @@ toc:
         url: /insomnia/enterprise-configure-ee-sso
       - title: Integrating Insomnia Enterprise with Okta SAML 2.0
         url: /insomnia/enterprise-configure-okta-saml
+      - title: Integrating Insomnia Enterprise with Okta OpenID Connect
+        url: /insomnia/enterprise-configure-okta-oidc
       - title: Integrating Insomnia Enterprise with Microsoft Azure/Entra ID SAML 2.0
         url: /insomnia/enterprise-configure-azure-saml
       - title: Insomnia Whitelisting Guide for Enterprise Users

diff --git a/docs/assets/images/insomnia-set-oidc.png b/docs/assets/images/insomnia-set-oidc.png
diff --git a/docs/assets/images/okta-app-oidc-name.png b/docs/assets/images/okta-app-oidc-name.png
diff --git a/docs/assets/images/okta-copy-oidc.png b/docs/assets/images/okta-copy-oidc.png
diff --git a/docs/assets/images/okta-oidc-assign-people.png b/docs/assets/images/okta-oidc-assign-people.png
diff --git a/docs/assets/images/okta-select-oidc.png b/docs/assets/images/okta-select-oidc.png
diff --git a/docs/assets/images/okta-set-issuer.png b/docs/assets/images/okta-set-issuer.png
diff --git a/docs/insomnia/enterprise-configure-ee-sso.md b/docs/insomnia/enterprise-configure-ee-sso.md
@@ -5,14 +5,14 @@ category: "Configuring EE SSO"
 category-url: enterprise-configure-ee-sso
 ---
 
-To set up Enterprise Single Sign-On (SSO) using a major SAML 2.0 provider like Okta or Azure in the Insomnia, you need to configure several fields.
+To set up Enterprise Single Sign-On (SSO) using a major identity provider like Okta or Azure in the Insomnia, you need to configure several fields.
 
 The process can slightly differ depending on the SAML provider, but here's a general guide that applies to most cases, using Okta and Azure as examples.
 
 Before setting up Enterprise SSO, you will need
 
 - An active enterprise account with Insomnia.
-- An admin account on your SAML provider (e.g., Okta or Azure).
+- An admin account on your identity provider (e.g., Okta or Azure).
 - An organization created after activating your Enterprise license within Insomnia.
 
 ![enterprise sso](../assets/images/enterprise_sso_start.jpg)
@@ -36,7 +36,7 @@ Before setting up Enterprise SSO, you will need
    - Example: `company.com`
 
 2. **Connection Type**
-   - Select `SAML 2.0` as the connection type.
+   - Select `SAML 2.0` or `OIDC` as the connection type.
 
 3. **SSO URL (Callback URL)**
    - Use the SSO URL provided by Insomnia. This is the callback URL where the SAML response will be sent.
@@ -66,11 +66,12 @@ You can also return to this list at any time and edit existing connections.
 
 ### Additional Notes
 
-- The specific navigation paths in Okta or Azure might vary slightly based on updates to their interfaces. Always refer to the latest documentation provided by your SAML provider.
+- The specific navigation paths in Okta or Azure might vary slightly based on updates to their interfaces. Always refer to the latest documentation provided by your identity provider.
 - After setting up SSO in Insomnia, it's recommended to test the SSO process to ensure everything is functioning correctly.
 - If you encounter issues, double-check the entered values, especially the SSO URL and the Certificate, as these are common points of error.
 
 This guide aims to provide a general idea of the setup process. For provider-specific instructions, it's advisable to consult the documentation of Okta or Azure or your provider, as they might have particular requirements or additional steps. See also our own guides:
 
 - [Integrating Insomnia Enterprise with Okta SAML 2.0](enterprise-configure-okta-saml)
 - [Integrating Insomnia Enterprise with Azure SAML 2.0](enterprise-configure-azure-saml)
+- [Integrating Insomnia Enterprise with Okta OpenID Connect](enterprise-configure-okta-oidc)
diff --git a/docs/insomnia/enterprise-configure-okta-oidc.md b/docs/insomnia/enterprise-configure-okta-oidc.md
@@ -0,0 +1,61 @@
+---
+layout: article-detail
+title:  Integrating Insomnia Enterprise with Okta OpenID Connect
+category: "Integrating Insomnia Enterprise with Okta OpenID Connect"
+category-url: enterprise-configure-okta-oidc
+---
+
+This guide outlines the steps for setting up Single Sign-On (SSO) for Insomnia Enterprise using Okta's OIDC integration, ensuring a secure and efficient user authentication process.
+
+#### Configuring Insomnia Enterprise
+
+- **Access Enterprise Controls:** In Insomnia, navigate to "Enterprise Controls."
+- **Create SSO Connection:** Click to create a new SSO Connection.
+- **SSO Configuration:** Set up your company domain in Insomnia and keep the page open to transfer details between Insomnia and Okta.
+
+#### Creating a New Application Integration in Okta
+
+1. **Navigate to Okta:** Go to Applications > Applications.
+2. **Initiate the Integration:** Click on "Create App Integration".
+
+   ![okta create app integration](/assets/images/okta-create-app-integration.jpg)
+
+3. **Choose Sign-in Method:** Select "OIDC - OpenID Connect" as the sign-in method.
+
+   ![okta saml 2](/assets/images/okta-select-oidc.png)
+
+#### Configuring the Application in Okta
+
+1. **Transfer SSO Details:** Copy the SSO URL from Insomnia to Okta.
+
+   ![okta set app name and Sign-in redirect URI](/assets/images/okta-app-oidc-name.png)
+
+2. **Set Issuer:** Set the issuer in Okta.
+
+   ![okta set issue](/assets/images/okta-set-issuer.png)
+
+3. **Transfer SSO Details:** Copy the client id, client secrets and the issuer URL from Okta to Insomnia.
+
+   ![okta client id and secrets](/assets/images/okta-copy-oidc.png)
+
+4. **SSO Configuration in Insomnia:** Define your organization's domain identifier.
+
+   ![insomnia enterprise sso set domain](/assets/images/insomnia-set-oidc.png)
+
+#### User Management
+
+1. **Assigning Users in Okta:** Assign users to the application.
+
+    ![okta app assign user](/assets/images/okta-oidc-assign-people.png)
+
+2. **Inviting Users in Insomnia:** Invite the same users in the Insomnia organization dashboard.
+
+    ![insomnia enterprise sso invite user](/assets/images/insomnia-enterprise-sso-invite-user.jpg)
+
+3. **User Onboarding:** Users can log in using Okta, set an encryption passphrase, and accept the enterprise invitation.
+
+    ![insomnia enterprise sso login](/assets/images/insomnia-enterprise-sso-login.jpg)
+
+    ![accept invite enterprise user](/assets/images/accept-invite-enterprise-user.jpg)
+
+Follow these steps to successfully integrate Insomnia Enterprise with Okta SAML for a streamlined and secure SSO experience.
diff --git a/docs/insomnia/enterprise-configure-okta-saml.md b/docs/insomnia/enterprise-configure-okta-saml.md
@@ -11,7 +11,7 @@ This guide outlines the steps for setting up Single Sign-On (SSO) for Insomnia E
 
 - **Access Enterprise Controls:** In Insomnia, navigate to "Enterprise Controls."
 - **Create SSO Connection:** Click to create a new SSO Connection.
-- **SSO Configuration:** Set up your company domain in Insomnia and keep the page open to transfer details between Insomnia and Azure.
+- **SSO Configuration:** Set up your company domain in Insomnia and keep the page open to transfer details between Insomnia and Okta.
 
 #### Creating a New Application Integration in Okta