ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-03-21 20:59:10 +00:00
Code Activity

keycloak module utils: group search optimization (#11503)

Browse source 
* Updated get_group_by_name with a query based lookup for improved speed

* Add changelog fragment for keycloak group search optimization

* Address review feedback: update changelog text and reformat code with ruff

* improved changelog fragment

* Update changelogs/fragments/11503-keycloak-group-search-optimization.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Andreas Wegmann 2026-02-14 21:06:28 +01:00 • committed by GitHub
parent 8729f563b3
commit 85a0deeeba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
plugins/module_utils/identity/keycloak/keycloak.py
View file

@ -1637,9 +1637,8 @@ class KeycloakAPI:
def get_group_by_name(self, name, realm: str = "master", parents=None):
"""Fetch a keycloak group within a realm based on its name.
The Keycloak API does not allow filtering of the Groups resource by name.
As a result, this method first retrieves the entire list of groups - name and ID -
then performs a second query to fetch the group.
Uses the Keycloak search API with exact matching for efficient lookup
instead of fetching all groups.
If the group does not exist, None is returned.
:param name: Name of the group to fetch.
@ -1653,11 +1652,21 @@ class KeycloakAPI:
if not parent:
return None
all_groups = self.get_subgroups(parent, realm)
# For subgroups: use children endpoint with search parameter
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent["id"]),
name=quote(name, safe=""),
)
else:
all_groups = self.get_groups(realm=realm)
# For top-level groups: use groups endpoint with search parameter
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUPS.format(url=self.baseurl, realm=realm), name=quote(name, safe="")
)
for group in all_groups:
groups = self._request_and_deserialize(search_url, method="GET")
# exact=true should return only exact matches, but verify the name
for group in groups:
if group["name"] == name:
return self.get_group_by_groupid(group["id"], realm=realm)