mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-16 07:26:35 +00:00
Update Jumpcloud SCIM (#461)
This commit is contained in:
Bethuel Mmbaga
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 184 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 152 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 122 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 299 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 181 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 253 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 234 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 234 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 205 KiB |
@@ -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,13 +21,49 @@ 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.
|
||||
|
||||
|
||||
|
||||
Click `Get Started` to launch the configuration wizard. You will be guided through several configuration options:
|
||||
|
||||
**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 `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.
|
||||
|
||||
|
||||
|
||||
Click `Continue` to generate your SCIM credentials.
|
||||
|
||||
**SCIM Credentials**
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Click `Finish Setup` to complete the NetBird SCIM configuration.
|
||||
|
||||
|
||||
|
||||
You can now proceed to configure the SCIM application in JumpCloud using the credentials generated above.
|
||||
|
||||
## 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.
|
||||
@@ -56,68 +82,34 @@ In the **Configuration Settings** section, enter the following SCIM Service Prov
|
||||
|
||||
If the connection is successful, you'll see a success message. Click `Activate` to enable SCIM provisioning.
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuring SCIM Provisioning to NetBird
|
||||
## Assigning Groups for SCIM Synchronization
|
||||
|
||||
On NetBird, click `Continue →`. You'll see instructions for configuring SCIM provisioning options.
|
||||
To enable SCIM synchronization of groups and their memberships to NetBird, you need to assign user groups to the NetBird SCIM application.
|
||||
|
||||
|
||||
In your [JumpCloud admin console](https://console.jumpcloud.com/):
|
||||
|
||||
Back in JumpCloud, configure the provisioning settings:
|
||||
|
||||
* 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 `Save` when you're done.
|
||||
|
||||
## Assigning NetBird Application to JumpCloud Users and Groups
|
||||
|
||||
In NetBird, click `Continue →` to see the steps for assigning users and groups.
|
||||
|
||||
|
||||
|
||||
In JumpCloud admin console:
|
||||
|
||||
* Navigate to your NetBird SSO application
|
||||
* Navigate to your `NetBird` SSO application
|
||||
* Click on the `User Groups` tab
|
||||
* Select the groups that should have access to NetBird
|
||||
* Select the groups whose members you want to synchronize to NetBird
|
||||
* Click `Save` to apply the changes
|
||||
|
||||
|
||||
|
||||
You can also assign individual users by clicking on the `Users` tab:
|
||||
|
||||
* Click `+` to add users
|
||||
* Search for and select users to assign to NetBird
|
||||
* Click `Save`
|
||||
|
||||
|
||||
|
||||
## Push JumpCloud Groups to NetBird
|
||||
|
||||
To synchronize groups from JumpCloud to NetBird:
|
||||
|
||||
* 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
|
||||
|
||||
|
||||
|
||||
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 Jumpcloud. 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>
|
||||
|
||||
Reference in New Issue
Block a user