Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 46 additions & 7 deletions src/pages/manage/team/idp-sync/keycloak-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<Note>
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
Groups where you can manually trigger the initial sync.
</Note>
## Initial Sync

After configuring the SCIM provider and resource filtering, you need to manually synchronize existing users and groups from Keycloak to NetBird.

### 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

After configuring mappings in Keycloak, the synchronization will begin based on your schedule settings. You can verify that users and groups
have been successfully synchronized by navigating to `Team > Users` in your NetBird dashboard.
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.

![NetBird Verify Users](/docs-static/img/manage/team/idp-sync/keycloak-sync/netbird-verify-users.png)

Expand Down
Loading