diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png new file mode 100644 index 00000000..a71e8cc3 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-connect.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-connect.png new file mode 100644 index 00000000..ca2e3a77 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-connect.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-activated.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-activated.png new file mode 100644 index 00000000..a3e0d162 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-activated.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png index f026754a..45e717d0 100644 Binary files a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-credentials.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-credentials.png new file mode 100644 index 00000000..2edfe0a4 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-credentials.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-enabled.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-enabled.png new file mode 100644 index 00000000..7f37bc69 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-enabled.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-getting-started.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-getting-started.png new file mode 100644 index 00000000..8edc581e Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-getting-started.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-group-filter.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-group-filter.png new file mode 100644 index 00000000..afe0d52d Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-group-filter.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-test-success.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-test-success.png new file mode 100644 index 00000000..11c8435f Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-test-success.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-user-group-filter.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-user-group-filter.png new file mode 100644 index 00000000..dd897c96 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-user-group-filter.png differ diff --git a/public/docs-static/img/how-to-guides/jumpcloud-sync/netbird-verify-users.png b/public/docs-static/img/how-to-guides/jumpcloud-sync/netbird-verify-users.png new file mode 100644 index 00000000..cf1a6624 Binary files /dev/null and b/public/docs-static/img/how-to-guides/jumpcloud-sync/netbird-verify-users.png differ diff --git a/src/pages/how-to/jumpcloud-sync.mdx b/src/pages/how-to/jumpcloud-sync.mdx index 28212238..7d5e03ef 100644 --- a/src/pages/how-to/jumpcloud-sync.mdx +++ b/src/pages/how-to/jumpcloud-sync.mdx @@ -8,16 +8,6 @@ NetBird's JumpCloud integration enhances user management by allowing you to util This integration automates user authentication in your network, adds SSO and MFA support, and simplifies network access management to your applications and resources. -The integration process consists of two stages: first, you'll work with the NetBird support team to set up Single Sign-On (SSO) -from NetBird's login page using JumpCloud credentials. Next, you'll configure SCIM (System for Cross-domain Identity Management) -to synchronize users and groups seamlessly. - -## Get Started with NetBird-JumpCloud Integration - -To set up SSO and SCIM provisioning, go to `Integrations` in the NetBird admin console's left menu to access the Identity Provider integration page. Click the `Connect JumpCloud` button to get started with the JumpCloud-NetBird integration. This will open a pop-up window with detailed instructions on synchronizing NetBird and JumpCloud. - -![NetBird JumpCloud Integration](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-integration-start.png) - ## Prerequisites Before you begin the integration process, ensure you have the necessary [admin permissions in JumpCloud](https://jumpcloud.com/support/admin-portal-roles). You need a JumpCloud user account with one of the following roles: @@ -31,93 +21,95 @@ These roles have the required permissions to configure SSO applications and mana Before configuring SCIM provisioning, you must first set up Single Sign-On (SSO) with JumpCloud. Please follow the detailed setup instructions in our [Single Sign-On guide for JumpCloud](/how-to/single-sign-on#jump-cloud). -Once SSO is configured and you can successfully log in to NetBird using your JumpCloud credentials, you can proceed with the SCIM setup below. +Once SSO is configured, and you can successfully log in to NetBird using your JumpCloud credentials, you can proceed with the SCIM setup below. ## Enabling JumpCloud SCIM in NetBird +To enable SCIM synchronization in NetBird, navigate to `Integrations > Identity Provider Sync` in your NetBird dashboard. +![NetBird Jumpcloud Integration](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-connect.png) -### Configure SCIM Application in JumpCloud +Click the `Connect Jumpcloud` button to begin the configuration process. -In your [JumpCloud admin console](https://console.jumpcloud.com/), go to `SSO Applications`, select your `NetBird` -application, and then select the `Identity Management` tab. +![NetBird Jumpcloud Getting Started](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-getting-started.png) -In the **Configuration Settings** section, enter the following SCIM Service Provider details: +Click `Get Started` to launch the configuration wizard. You will be guided through several configuration options: -* **API Type**: `SCIM API` (default) -* **SCIM Version**: `SCIM 2.0` (default) -* **Base URL**: `https://api.netbird.io/api/scim/v2` -* **Token Key**: Paste the Bearer token you copied from NetBird -* **Test User Email**: Provide a new, unused email address for testing (e.g., `test@yourdomain.com`) +**Groups to be synchronized** -![JumpCloud SCIM Configuration](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png) +By default, all groups assigned to the NetBird application in JumpCloud will be synchronized. If you want to synchronize only assigned groups that start with a specific prefix, you can specify them in the filter. Keep in mind that the prefix matching is case-sensitive. -* Click `Test Connection` to verify the SCIM connection +![NetBird Jumpcloud Group Filter](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-group-filter.png) -If the connection is successful, you'll see a success message. Click `Activate` to enable SCIM provisioning. +Click `Continue` to proceed to the next step. + +**Users to be synchronized** -![JumpCloud SCIM Test Success](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-test-success.png) +By default, all users from the groups assigned to the NetBird application will be synchronized. If you want to further filter and synchronize only users from specific assigned groups, you can specify those group names in the filter. The group name matching is case-sensitive. -## Configuring SCIM Provisioning to NetBird +![NetBird Jumpcloud User Group Filter](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-user-group-filter.png) -On NetBird, click `Continue →`. You'll see instructions for configuring SCIM provisioning options. +Click `Continue` to generate your SCIM credentials. -![NetBird Configure SCIM Provisioning](/docs-static/img/how-to-guides/jumpcloud-sync/netbird-configure-provisioning.png) +**SCIM Credentials** -Back in JumpCloud, configure the provisioning settings: +NetBird will generate the SCIM credentials required to configure JumpCloud. Make note of both the **Base URL** and **Token Key** as you will need them in the next section to complete the JumpCloud configuration. -* Under the `Identity Management` tab in your NetBird application -* Enable the following options: - * **Create Users**: Automatically create users in NetBird when assigned in JumpCloud - * **Update User Attributes**: Sync user profile changes from JumpCloud to NetBird - * **Deactivate Users**: Remove access when users are unassigned in JumpCloud - * **Push Groups**: Synchronize JumpCloud groups to NetBird +![NetBird Jumpcloud SCIM Credentials](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-credentials.png) -![JumpCloud Enable Provisioning Options](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-enable-provisioning.png) +Click `Finish Setup` to complete the NetBird SCIM configuration. -Click `Save` when you're done. +![NetBird Jumpcloud SCIM Enabled](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-enabled.png) -## Assigning NetBird Application to JumpCloud Users and Groups +You can now proceed to configure the SCIM application in JumpCloud using the credentials generated above. -In NetBird, click `Continue →` to see the steps for assigning users and groups. +## Configure SCIM Application in JumpCloud -![NetBird Assign Users and Groups](/docs-static/img/how-to-guides/jumpcloud-sync/netbird-assign-users-groups.png) +In your [JumpCloud admin console](https://console.jumpcloud.com/), go to `SSO Applications`, select your `NetBird` +application, and then select the `Identity Management` tab. -In JumpCloud admin console: +In the **Configuration Settings** section, enter the following SCIM Service Provider details: -* Navigate to your NetBird SSO application -* Click on the `User Groups` tab -* Select the groups that should have access to NetBird +* **API Type**: `SCIM API` (default) +* **SCIM Version**: `SCIM 2.0` (default) +* **Base URL**: `https://api.netbird.io/api/scim/v2` +* **Token Key**: Paste the Bearer token you copied from NetBird +* **Test User Email**: Provide a new, unused email address for testing (e.g., `test@yourdomain.com`) -![JumpCloud Assign Groups](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png) +![JumpCloud SCIM Configuration](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png) + +* Click `Test Connection` to verify the SCIM connection -You can also assign individual users by clicking on the `Users` tab: +If the connection is successful, you'll see a success message. Click `Activate` to enable SCIM provisioning. -* Click `+` to add users -* Search for and select users to assign to NetBird -* Click `Save` +![JumpCloud SCIM Test Success](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-activated.png) -![JumpCloud Assign Users](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-users.png) +## Assigning Groups for SCIM Synchronization -## Push JumpCloud Groups to NetBird +To enable SCIM synchronization of groups and their memberships to NetBird, you need to assign user groups to the NetBird SCIM application. -To synchronize groups from JumpCloud to NetBird: +In your [JumpCloud admin console](https://console.jumpcloud.com/): -* In your NetBird application in JumpCloud -* Go to the `Identity Management` tab -* Under `Group Management`, select `Push Groups` -* Choose which groups to sync to NetBird +* Navigate to your `NetBird` SSO application +* Click on the `User Groups` tab +* Select the groups whose members you want to synchronize to NetBird +* Click `Save` to apply the changes -![JumpCloud Push Groups](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-push-groups.png) +![JumpCloud Assign Groups](/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png) -Once configured, JumpCloud will automatically push the selected groups to NetBird. +Once saved, JumpCloud will automatically synchronize the selected groups and their user memberships to NetBird. ## Verify Synchronization -Return to NetBird and click `Finish Setup`. You can verify the synchronization by navigating to `Team > Users` in the NetBird console. +After assigning groups in JumpCloud, the synchronization will begin automatically. You can verify that users and groups +have been successfully synchronized by navigating to `Team > Users` in your NetBird dashboard. ![NetBird Verify Users](/docs-static/img/how-to-guides/jumpcloud-sync/netbird-verify-users.png) -The users and groups listed in NetBird should match those you configured in JumpCloud. + + SCIM provisioning will manage only resources that are created through Jumpcloud. Any resources created directly in NetBird will not be managed by SCIM. + -![NetBird Users Synced](/docs-static/img/how-to-guides/jumpcloud-sync/netbird-users-synced.png) \ No newline at end of file + + Synced groups will only be available for membership and will not change the role of user in NetBird +