Skip to content

fix: retain omitted name subattributes on PUT /Users #106

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.

Sign up for GitHub

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

Open
nicolamacoir wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

fix: retain omitted name subattributes on PUT /Users #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a3af32
fix: retain omitted name subattributes on PUT /Users
nicolamacoir May 19, 2026
e4d0772
Merge branch 'develop' into fix/put-user-omitted-name-subattributes
nicolamacoir Jun 1, 2026
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
8 changes: 6 additions & 2 deletions src/main/java/fi/metatavu/keycloak/scim/server/users/UsersController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,12 @@ public fi.metatavu.keycloak.scim.server.model.User updateUser(
((BooleanUserAttribute) userAttributes.findByScimPath("active")).write(existing, scimUser.getActive() == null || Boolean.TRUE.equals(scimUser.getActive()));

if (scimUser.getName() != null) {
((StringUserAttribute) userAttributes.findByScimPath("name.givenName")).write(existing, scimUser.getName().getGivenName());
((StringUserAttribute) userAttributes.findByScimPath("name.familyName")).write(existing, scimUser.getName().getFamilyName());
if (scimUser.getName().getGivenName() != null) {
((StringUserAttribute) userAttributes.findByScimPath("name.givenName")).write(existing, scimUser.getName().getGivenName());
}
if (scimUser.getName().getFamilyName() != null) {
((StringUserAttribute) userAttributes.findByScimPath("name.familyName")).write(existing, scimUser.getName().getFamilyName());
}
}

if (scimUser.getEmails() != null && !scimUser.getEmails().isEmpty()) {
Expand Down
43 changes: 43 additions & 0 deletions ...t/java/fi/metatavu/keycloak/scim/server/test/tests/functional/RealmUserUpdateTestsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import fi.metatavu.keycloak.scim.server.test.TestConsts;
import fi.metatavu.keycloak.scim.server.test.client.ApiException;
import fi.metatavu.keycloak.scim.server.test.client.model.User;
import fi.metatavu.keycloak.scim.server.test.client.model.UserName;
import fi.metatavu.keycloak.scim.server.test.tests.AbstractInternalAuthRealmScimTest;
import org.junit.jupiter.api.Test;
import org.keycloak.events.admin.AdminEvent;
Expand Down Expand Up @@ -191,4 +192,46 @@ void testUpdateUserAdminEvents() throws ApiException, IOException {
// Cleanup
deleteRealmUser(TestConsts.TEST_REALM, created.getId());
}

/**
* Regression: omitted "name.familyName" in a PUT body must retain the existing value.
* Previously the request unconditionally wrote null when the parent "name" object was
* present, clearing the existing family name. RFC 7644 §3.5.1 says omitted readWrite
* attributes MAY be assumed to be unchanged — applies to subattributes too.
*/
@Test
void testReplaceUserRetainsOmittedNameSubattributes() throws ApiException {
ScimClient scimClient = getAuthenticatedScimClient();

User user = new User();
user.setUserName("omitted-name-sub");
user.setActive(true);
user.setSchemas(List.of("urn:ietf:params:scim:schemas:core:2.0:User"));
user.setName(getName("Original", "Lastname"));
user.setEmails(getEmails("omitted.name.sub@example.com"));

User created = scimClient.createUser(user);
String userId = created.getId();

// PUT with only givenName under name; familyName omitted
User replacement = new User();
replacement.setUserName(user.getUserName());
replacement.setActive(true);
replacement.setSchemas(List.of("urn:ietf:params:scim:schemas:core:2.0:User"));
UserName partialName = new UserName();
partialName.setGivenName("NewGiven");
replacement.setName(partialName);

User updated = scimClient.updateUser(userId, replacement);

assertNotNull(updated.getName());
assertEquals("NewGiven", updated.getName().getGivenName());
assertEquals("Lastname", updated.getName().getFamilyName(), "familyName must be retained when omitted in PUT");

UserRepresentation realmUser = findRealmUser(TestConsts.TEST_REALM, userId);
assertEquals("NewGiven", realmUser.getFirstName());
assertEquals("Lastname", realmUser.getLastName());

deleteRealmUser(TestConsts.TEST_REALM, userId);
}
}
Loading