Repository navigation
User-API: User search parameter to include/exclude service accounts #48031
Description
Description
We are using the REST API extensively and need more control over including/excluding service-accounts.
To prevent breaking the API, we could add an Optional parameter, which still provides the default/legacy behavior, if it is null.
Value Proposition
This provides deterministic results regarding service-account inclusion/exclusion independent from old implementation, which made sense for the use cases at the time.
It offers also more flexibility for future usage, like separate administration areas fur user accounts and service account (which is considered in some discussions as far as I am aware).
Goals
A new parameter to explicitly include/exclude service accounts.
Non-Goals
Change existing behavior.
Discussion
No response
Notes
Possibly related issues/discussions:
- Search Users - Query Param for Service Account Search #36515
- Service accounts visible under user search in Admin console #34233
- API user search for empty username gives service accounts instead of empty list #42273
I am planning to provide a pull request for this.
Activity
ZhenggangRen-Web commentedon Aug 18, 2026
this looks good, when use q param, will filter the service account user defaultly if matched the keyword.
Introduce new user search parameter for service account inclusion/exc…
JoHeinem commentedon Oct 21, 2026
Hi @stianst , sorry for the direct ping. We (UP42) also rely heavily on the Admin REST API and would really benefit from an explicit include/exclude flag for service accounts in user search, since right now we have to filter them out ourselves. The PR (keycloak/keycloak#48033) has been ready with green CI since end of August but hasn’t been triaged yet. Is this something you’d accept for the current Admin API? Happy to help test or adjust the PR either way.
Introduce new user search parameter for service account inclusion/exc…
Introduce new user search parameter for service account inclusion/exc…