-
Notifications
You must be signed in to change notification settings - Fork 78
Update Jumpcloud SCIM #461
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8932869
Add JumpCloud integration doc
bcmmbaga 6083943
Merge branch 'refs/heads/main' into jumpcloud-scim
bcmmbaga 13c15ce
Merge branch 'refs/heads/main' into jumpcloud-scim
bcmmbaga 1ee9ff2
update jumpcloud scim
bcmmbaga f805156
Update src/pages/how-to/jumpcloud-sync.mdx
bcmmbaga File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+53.9 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-assign-groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+184 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+152 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-activated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+32.4 KB
(140%)
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+299 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+181 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+253 KB
...docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-getting-started.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+234 KB
...ic/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-group-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+154 KB
...ic/docs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-test-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+234 KB
...cs-static/img/how-to-guides/jumpcloud-sync/jumpcloud-scim-user-group-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+205 KB
public/docs-static/img/how-to-guides/jumpcloud-sync/netbird-verify-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
|  | ||
|
|
||
| ## 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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. | ||
|  | ||
|
|
||
| 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., `[email protected]`) | ||
| **Groups to be synchronized** | ||
|
|
||
|  | ||
| 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 | ||
|  | ||
|
|
||
| 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** | ||
|
|
||
|  | ||
| 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 | ||
|  | ||
|
|
||
| On NetBird, click `Continue →`. You'll see instructions for configuring SCIM provisioning options. | ||
| Click `Continue` to generate your SCIM credentials. | ||
|
|
||
|  | ||
| **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 | ||
|  | ||
|
|
||
|  | ||
| Click `Finish Setup` to complete the NetBird SCIM configuration. | ||
|
|
||
| Click `Save` when you're done. | ||
|  | ||
|
|
||
| ## 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 | ||
|
|
||
|  | ||
| 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., `[email protected]`) | ||
|
|
||
|  | ||
|  | ||
|
|
||
| * 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` | ||
|  | ||
|
|
||
|  | ||
| ## 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 | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| The users and groups listed in NetBird should match those you configured in JumpCloud. | ||
| <Note> | ||
| SCIM provisioning will manage only resources that are created through Okta. Any resources created directly in NetBird will not be managed by SCIM. | ||
| </Note> | ||
|
|
||
|  | ||
| <Note> | ||
| Synced groups will only be available for membership and will not change the role of user in NetBird | ||
| </Note> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.