Update keycloak initial sync steps (#654)

This commit is contained in:
Bethuel Mmbaga
2026-03-16 12:28:45 +01:00
committed by GitHub
parent e0f5fbf445
commit 31a1eb5642
4 changed files with 46 additions and 7 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

View File

@@ -142,16 +142,55 @@ To synchronize only groups that match specific criteria, configure the group fil
![Keycloak SCIM Filtering Configuration](/docs-static/img/manage/team/idp-sync/keycloak-sync/keycloak-scim-filtering-config.png) ![Keycloak SCIM Filtering Configuration](/docs-static/img/manage/team/idp-sync/keycloak-sync/keycloak-scim-filtering-config.png)
<Note> ## Initial Sync
By default, Keycloak SCIM will not automatically push existing users and groups after the initial configuration.
To synchronize existing resources, navigate to `Synchronization` tab. Here you will find two tabs for Users and After configuring the SCIM provider and resource filtering, you need to manually synchronize existing users and groups from Keycloak to NetBird.
Groups where you can manually trigger the initial sync.
</Note> ### Sync Users
Navigate to the `Synchronization` tab in your SCIM provider configuration and select `User Synchronization`.
Confirm the following settings:
* **Identifier**: Set to `Username`
* **Synchronization Strategy**: Set to `Get and (update or create) Strategy`
![Keycloak SCIM User Sync Settings](/docs-static/img/manage/team/idp-sync/keycloak-sync/keycloak-scim-user-sync-settings.png)
Click `Count local and remote resources` to validate that the **Local User Count** and **Remote User Count** values are as expected.
Once validated, click `Synchronize all resources from startIndex` to sync all users.
### Sync Groups
Navigate to the `Synchronization` tab and select `Group Synchronization`.
Confirm the following settings:
* **Operation Type**: Set to `Create Group`
* **Synchronization Strategy**: Set to `Get and (update or create) Strategy`
![Keycloak SCIM Group Sync Settings](/docs-static/img/manage/team/idp-sync/keycloak-sync/keycloak-scim-group-sync-settings.png)
Click `Count local and remote resources` to validate that the **Local Group Count** and **Remote Group Count** values are as expected.
Once validated, click `Synchronize all resources from startIndex` to sync all groups.
### Sync Group Membership
Navigate to the `Synchronization` tab and select `Group Synchronization`.
Confirm the following settings:
* **Operation Type**: Set to `Update Group Members`
* **Synchronization Strategy**: Set to `Get and (update or create) Strategy`
![Keycloak SCIM Group Membership Sync Settings](/docs-static/img/manage/team/idp-sync/keycloak-sync/keycloak-scim-group-membership-sync-settings.png)
Click `Count local and remote resources` to validate that the **Local Group Count** and **Remote Group Count** values are as expected.
Once validated, click `Synchronize all resources from startIndex` to sync all group memberships.
## Verify Synchronization ## Verify Synchronization
After configuring mappings in Keycloak, the synchronization will begin based on your schedule settings. You can verify that users and groups After completing the initial sync, you can verify that users and groups have been successfully synchronized by navigating to `Team > Users` in your NetBird dashboard.
have been successfully synchronized by navigating to `Team > Users` in your NetBird dashboard.
![NetBird Verify Users](/docs-static/img/manage/team/idp-sync/keycloak-sync/netbird-verify-users.png) ![NetBird Verify Users](/docs-static/img/manage/team/idp-sync/keycloak-sync/netbird-verify-users.png)