SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-08-04 19:55:09 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

[PR #1095] Fix bug with updating Keycloak user attributes #3000

New Issue
Open
opened 2025-11-20 08:04:38 -05:00 by saavagebueno · 0 comments
saavagebueno commented 2025-11-20 08:04:38 -05:00
Owner
Copy Link

Original Pull Request: https://github.com/netbirdio/netbird/pull/1095

State: closed
Merged: No

Describe your changes

When using Keycloak as an IdP, NetBird will attempt to write the attributes wt_pending_invite and wt_account_id to the user's profile the first time they log in. This is done through the Keycloak Admin REST API via a PUT request to /admin/{realm}/users/{id}. However, an undocumented function of this API endpoint is it overwrites all attributes on the account, including the email, firstName, and lastName fields. If these fields are not specified in the request it overwrites them to blank values.

This can be replicated by creating an account in Keycloak, then logging into a NetBird instance for the first time. You will see that after login the name and email fields are now blank along with any custom attributes in the profile.

Since the Keycloak API doesn't have a PATCH endpoint, we can fix this by getting the user's profile first then appending the attributes to it.

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)
  • Extended the README / documentation, if necessary
**Original Pull Request:** https://github.com/netbirdio/netbird/pull/1095 **State:** closed **Merged:** No --- ## Describe your changes When using Keycloak as an IdP, NetBird will attempt to write the attributes `wt_pending_invite` and `wt_account_id` to the user's profile the first time they log in. This is done through the Keycloak Admin REST API via a PUT request to `/admin/{realm}/users/{id}`. However, an undocumented function of this API endpoint is it overwrites *all* attributes on the account, including the `email`, `firstName`, and `lastName` fields. If these fields are not specified in the request it overwrites them to blank values. This can be replicated by creating an account in Keycloak, then logging into a NetBird instance for the first time. You will see that after login the name and email fields are now blank along with any custom attributes in the profile. Since the Keycloak API doesn't have a PATCH endpoint, we can fix this by getting the user's profile first then appending the attributes to it. ### Checklist - [X] Is it a bug fix - [ ] Is a typo/documentation fix - [ ] Is a feature enhancement - [ ] It is a refactor - [ ] Created tests that fail without the change (if possible) - [ ] Extended the README / documentation, if necessary
saavagebueno added the pull-request label 2025-11-20 08:04:38 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#3000
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?