Username can be updated in configuration (#1204)

* Allow users to update their username through configuration

* Allow users to update their username through configuration

* Allow users to update their username through configuration

* Allow users to update their username through configuration

* Allow users to update their username through configuration

* Fix for workflow failure

* Fix for workflow failure

* fix: ci failure

* Using more parameters to search for user

---------

Co-authored-by: AssahBismarkabah <[email protected]>

Author: Thendo20

.github/workflows/ci.yaml

@@ -280,7 +280,7 @@ jobs:
 
       - uses: actions/[email protected]
         with:
-          python-version: 3.7
+          python-version: 3.9
 
       - uses: actions/[email protected]
         with:

CHANGELOG.md

@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Allow a user's username to be updated through the config [#810](https://github.com/adorsys/keycloak-config-cli/issues/810)
 
 ## [6.3.0] - 2025-02-03
 ### Added

src/main/java/de/adorsys/keycloak/config/repository/UserRepository.java

@@ -68,11 +68,30 @@ public Optional<UserRepresentation> search(String realmName, String username) {
         return user;
     }
 
+    public Optional<UserRepresentation> searchByAttributes(String realmName, String email, String firstname, String lastname) {
+        UsersResource usersResource = realmRepository.getResource(realmName).users();
+        List<UserRepresentation> foundUsers = usersResource.search("", firstname, lastname, email,
+                null, null, null, 0, 100, null, null);
+
+        for (UserRepresentation user : foundUsers) {
+            if (email.equalsIgnoreCase(user.getEmail()) && firstname.equalsIgnoreCase(user.getFirstName())
+                    && lastname.equalsIgnoreCase(user.getLastName())) {
+                return Optional.of(user);
+            }
+        }
+        return Optional.empty();
+    }
+
     final UserResource getResource(String realmName, String username) {
         UserRepresentation user = get(realmName, username);
         return realmRepository.getResource(realmName).users().get(user.getId());
     }
 
+    final UserResource getResource(String realmName, String username, String email, String firstname, String lastname) {
+        UserRepresentation user = get(realmName, username, email, firstname, lastname);
+        return realmRepository.getResource(realmName).users().get(user.getId());
+    }
+
     public UserRepresentation get(String realmName, String username) {
         Optional<UserRepresentation> user = search(realmName, username);
 
@@ -81,6 +100,17 @@ public UserRepresentation get(String realmName, String username) {
         );
     }
 
+    public UserRepresentation get(String realmName, String username, String email, String firstname, String lastname) {
+        Optional<UserRepresentation> user = search(realmName, username);
+        if (user.isEmpty()) {
+            user = searchByAttributes(realmName, email, firstname, lastname);
+        }
+
+        return user.orElseThrow(
+                () -> new KeycloakRepositoryException("Cannot find user '%s' or user with email '%s'  in realm '%s'", username, email, realmName)
+        );
+    }
+
     public void create(String realmName, UserRepresentation user) {
         RealmResource realmResource = realmRepository.getResource(realmName);
         UsersResource usersResource = realmResource.users();
@@ -91,7 +121,7 @@ public void create(String realmName, UserRepresentation user) {
     }
 
     public void updateUser(String realmName, UserRepresentation user) {
-        UserResource userResource = getResource(realmName, user.getUsername());
+        UserResource userResource = getResource(realmName, user.getUsername(), user.getEmail(), user.getFirstName(), user.getLastName());
         userResource.update(user);
     }
 

src/main/java/de/adorsys/keycloak/config/service/UserImportService.java

@@ -129,6 +129,11 @@ public void importUser() {
 
             Optional<UserRepresentation> maybeUser = userRepository.search(realmName, userToImport.getUsername());
 
+            if (maybeUser.isEmpty() && userToImport.getEmail() != null) {
+                maybeUser = userRepository.searchByAttributes(realmName, userToImport.getEmail(), userToImport.getFirstName(),
+                        userToImport.getLastName());
+            }
+
             if (maybeUser.isPresent()) {
                 updateUser(maybeUser.get());
             } else {

src/test/java/de/adorsys/keycloak/config/service/ImportUsersIT.java

@@ -593,6 +593,33 @@ void shouldUpdateUserWithEmailAsRegistration() throws IOException {
         assertThat(user.getFirstName(), is("My firstname 2"));
         assertThat(user.getLastName(), is("My lastname 2"));
     }
+    @Test
+    @Order(70)
+    void shouldUpdateUserWithNewUsername() throws IOException {
+        doImport("16.1_update_realm_change_users_username.json");
+
+        RealmRepresentation createdRealm = keycloakProvider.getInstance().realm(REALM_NAME).toRepresentation();
+
+        assertThat(createdRealm.getRealm(), is(REALM_NAME));
+        assertThat(createdRealm.isEnabled(), is(true));
+
+        UserRepresentation user = keycloakRepository.getUser(REALM_NAME, "jake");
+
+        assertThat(user.getUsername(), is("jake"));
+        assertThat(user.getEmail(), is("[email protected]"));
+        assertThat(user.isEnabled(), is(true));
+        assertThat(user.getFirstName(), is("My firstname"));
+        assertThat(user.getLastName(), is("My lastname"));
+
+        doImport("16.2_update_realm_change_users_username.json");
+        UserRepresentation updatedUser= keycloakRepository.getUser(REALM_NAME, "john123");
+        assertThat(updatedUser.getUsername(), is("john123"));
+        assertThat(updatedUser.getEmail(), is("[email protected]"));
+        assertThat(updatedUser.isEnabled(), is(true));
+        assertThat(updatedUser.getFirstName(), is("My firstname"));
+        assertThat(updatedUser.getLastName(), is("My lastname"));
+
+    }
 
     @Test
     @Order(80)

src/test/resources/import-files/users/16.1_update_realm_change_users_username.json

@@ -0,0 +1,15 @@
+{
+  "enabled": true,
+  "realm": "realmWithUsers",
+  "registrationEmailAsUsername": false,
+  "editUsernameAllowed": true,
+  "users": [
+    {
+      "username": "jake",
+      "email": "[email protected]",
+      "enabled": true,
+      "firstName": "My firstname",
+      "lastName": "My lastname"
+    }
+  ]
+}

src/test/resources/import-files/users/16.2_update_realm_change_users_username.json

@@ -0,0 +1,15 @@
+{
+  "enabled": true,
+  "realm": "realmWithUsers",
+  "registrationEmailAsUsername": false,
+  "editUsernameAllowed": true,
+  "users": [
+    {
+      "username": "john123",
+      "email": "[email protected]",
+      "enabled": true,
+      "firstName": "My firstname",
+      "lastName": "My lastname"
+    }
+  ]
+}