[PR #12105/7b8ed586 backport][stable-13] new module: keycloak_realm_users_info (#12229)

new module: keycloak_realm_users_info (#12105)

* init keycloak user info

* fix docs

* rename

* nox -Re formatters

* botmeta

* update runtime.yml

* fix line too long

* fix stupid

* mv keycloak_realm_users.py keycloak_realm_users_info.py

* add integration test

* fix integrationtest

* fix version_added



* fix eof

* use other file as template

* use keycloak_client_rolescope as basis

* refactor functions

* fix extends_documentation_fragment

* clean some things up

* improve diff?

* docstring

* revert to old logic

---------


(cherry picked from commit 7b8ed586da)

Co-authored-by: felix-grzelka <felix.grzelka@dataport.de>
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

plugins/module_utils/_keycloak.py

@@ -1085,24 +1085,21 @@ class KeycloakAPI:
         except Exception as e:
             self.fail_request(e, msg=f"Could not fetch effective rolemappings for user {uid}, realm {realm}: {e}")
 
-    def get_user_by_username(self, username, realm: str = "master"):
+    def get_user_by_username(self, username: str, realm: str = "master") -> dict[str, t.Any] | None:
         """Fetch a keycloak user within a realm based on its username.
 
-        If the user does not exist, None is returned.
+        If the username is not found, None is returned.
         :param username: Username of the user to fetch.
         :param realm: Realm in which the user resides; default 'master'
         """
         users_url = URL_USERS.format(url=self.baseurl, realm=realm)
         users_url += f"?username={quote(username, safe='')}&exact=true"
         try:
-            userrep = None
             users = self._request_and_deserialize(users_url, method="GET")
             for user in users:
                 if user["username"] == username:
-                    userrep = user
-                    break
-            return userrep
-
+                    return user
+            return None
         except ValueError as e:
             self.module.fail_json(
                 msg=f"API returned incorrect JSON when trying to obtain the user for realm {realm} and username {username}: {e}"
@@ -1110,6 +1107,22 @@ class KeycloakAPI:
         except Exception as e:
             self.fail_request(e, msg=f"Could not obtain the user for realm {realm} and username {username}: {e}")
 
+    def get_realm_users(self, realm: str = "master") -> list[dict[str, t.Any]]:
+        """Obtain list of users from the realm
+
+        :param realm: realm id
+        :return: list of user representations
+        """
+        users_url = URL_USERS.format(url=self.baseurl, realm=realm)
+        try:
+            return self._request_and_deserialize(users_url, method="GET")
+        except ValueError as e:
+            self.module.fail_json(
+                msg=f"API returned incorrect JSON when trying to obtain the users for realm {realm}: {e}"
+            )
+        except Exception as e:
+            self.fail_request(e, msg=f"Could not obtain the users for realm {realm}: {e}")
+
     def get_service_account_user_by_client_id(self, client_id, realm: str = "master"):
         """Fetch a keycloak service account user within a realm based on its client_id.
 

plugins/modules/keycloak_clientsecret_info.py

@@ -104,11 +104,6 @@ EXAMPLES = r"""
 """
 
 RETURN = r"""
-msg:
-  description: Textual description of whether we succeeded or failed.
-  returned: always
-  type: str
-
 clientsecret_info:
   description: Representation of the client secret.
   returned: on success

plugins/modules/keycloak_realm_users_info.py

@@ -0,0 +1,122 @@
+#!/usr/bin/python
+
+# Copyright (c) Ansible project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import annotations
+
+DOCUMENTATION = r"""
+module: keycloak_realm_users_info
+
+short_description: Retrieve users from a Keycloak realm using the Keycloak API
+
+version_added: 13.1.0
+
+description:
+  - This module retrieves all users from a specified Keycloak realm using the Keycloak REST API.
+  - Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions.
+  - Authentication can be performed either with username/password or with a token.
+  - The names of module options are snake_case versions of the camelCase ones found in the Keycloak API
+    and its documentation at U(https://www.keycloak.org/docs-api/18.0/rest-api/index.html).
+
+attributes:
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
+
+options:
+  realm:
+    type: str
+    description:
+      - The Keycloak realm from which users should be retrieved.
+    default: 'master'
+
+extends_documentation_fragment:
+  - community.general._keycloak
+  - community.general._attributes
+  - community.general._attributes.info_module
+
+author:
+  - Felix Grzelka (@felix-grzelka)
+"""
+
+EXAMPLES = r"""
+- name: List all users in the "MyCustomRealm" realm using username/password authentication
+  community.general.keycloak_realm_users_info:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com/auth
+    auth_realm: master
+    auth_username: USERNAME
+    auth_password: PASSWORD
+  delegate_to: localhost
+
+- name: List all users in the "MyCustomRealm" realm using a token
+  community.general.keycloak_realm_users_info:
+    realm: MyCustomRealm
+    auth_client_id: admin-cli
+    auth_keycloak_url: https://auth.example.com/auth
+    token: TOKEN
+  delegate_to: localhost
+"""
+
+RETURN = r"""
+users:
+  description: List of users in the specified realm.
+  returned: always
+  type: list
+  elements: dict
+  sample:
+    - id: "1234-5678-90"
+      username: "user1"
+      email: "user1@example.com"
+    - id: "2345-6789-01"
+      username: "user2"
+      email: "user2@example.com"
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+
+from ansible_collections.community.general.plugins.module_utils._keycloak import (
+    KeycloakAPI,
+    KeycloakError,
+    get_token,
+    keycloak_argument_spec,
+)
+
+
+def main():
+    argument_spec = keycloak_argument_spec()
+
+    argument_spec["realm"] = dict(default="master")
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_one_of=(
+            [["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"]]
+        ),
+        required_together=([["auth_username", "auth_password"]]),
+        required_by={"refresh_token": "auth_realm"},
+    )
+
+    result = dict(changed=False, msg="", users="")
+
+    # Obtain access token, initialize API
+    try:
+        connection_header = get_token(module.params)
+    except KeycloakError as e:
+        module.fail_json(msg=str(e))
+
+    kc = KeycloakAPI(module, connection_header)
+
+    realm = module.params.get("realm")
+
+    result["users"] = kc.get_realm_users(realm=realm)
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()