Implementation of UserQueryProvider #42302

havarnov · 2025-09-03T08:36:21Z

havarnov
Sep 3, 2025

I want to implement the UserQueryProvider interface for my custom UserStorage, specifically to be able to find users by username (exact):

curl 'https://<HOST>/admin/realms/<REALM>/users?exact=true&username=<USERNAME>'

My implementation is as follows, as you can see it only supports USERNAME && EXACT.

    public Stream<UserModel> searchForUserStream(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) {
        if (params.containsKey(UserModel.EXACT) && params.containsKey(UserModel.USERNAME)) {
            var username = params.get(UserModel.USERNAME);
            if (username != null) {
                user = this.getUserByUsername(realm, username);
                if (user != null) {
                    return Stream.of(user);
                }
            }
        }

        return Stream.empty();
    }

This works, but if the username already exists in the local database (Keycloaks database) the request above will return the user twice. I guess that Keycloak calls searchForUserStream() on both the local storage and my custom UserStorage?

What I'm a doing wrong? (My current work-around is to only return the user from my custom implementation if it's not in the local storage from before.

Navigation Menu

Repository navigation

Implementation of UserQueryProvider #42302

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

Implementation of UserQueryProvider #42302

Uh oh!

Uh oh!

havarnov Sep 3, 2025

Replies: 0 comments

havarnov
Sep 3, 2025