From 2a7834c5e479eb990ac7f60d3398e97c0759f6eb Mon Sep 17 00:00:00 2001 From: Aleksandr Mangin Date: Wed, 28 Oct 2026 12:59:56 +0100 Subject: [PATCH] keycloak_userprofile: support required.scopes Keycloak can require a user profile attribute only when one of the given client scopes is requested, but the module's argument spec only accepted required.roles and rejected required.scopes. --- .../keycloak_userprofile/vars.yml | 19 +++++++++++++ .../keycloak_userprofile/verify.yml | 27 +++++++++++++++++++ plugins/modules/keycloak_userprofile.py | 13 ++++++++- 3 files changed, 58 insertions(+), 1 deletion(-) diff --git a/molecule/keycloak_modules/keycloak_userprofile/vars.yml b/molecule/keycloak_modules/keycloak_userprofile/vars.yml index d598333..6ef7e86 100644 --- a/molecule/keycloak_modules/keycloak_userprofile/vars.yml +++ b/molecule/keycloak_modules/keycloak_userprofile/vars.yml @@ -107,3 +107,22 @@ config_unmanaged_attributes_admin_view: kc_user_profile_config: - unmanagedAttributePolicy: ADMIN_VIEW attributes: "{{ attributes_default }}" + +attributes_required_by_scope: + - name: requiredByScope + displayName: requiredByScope + required: + roles: + - user + scopes: + - profile + permissions: + view: + - admin + - user + edit: [] + multivalued: false + +config_required_by_scope: + kc_user_profile_config: + - attributes: "{{ attributes_default + attributes_required_by_scope }}" diff --git a/molecule/keycloak_modules/keycloak_userprofile/verify.yml b/molecule/keycloak_modules/keycloak_userprofile/verify.yml index 11c8bdb..9330f51 100644 --- a/molecule/keycloak_modules/keycloak_userprofile/verify.yml +++ b/molecule/keycloak_modules/keycloak_userprofile/verify.yml @@ -185,3 +185,30 @@ - result.end_state.providerId == "declarative-user-profile" - result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider" - result.msg.startswith("Userprofile declarative-user-profile changed:") + +- name: Require an attribute only for a client scope + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: "{{ ephemeral_realm }}" + config: "{{ config_required_by_scope }}" + diff: true + register: result + +- name: Assert the attribute is required for the scope + ansible.builtin.assert: + that: + - result is changed + - (result.end_state.config['kc.user.profile.config'][0].attributes | selectattr('name', 'equalto', 'requiredByScope') | first).required.scopes == ['profile'] + +- name: Require an attribute only for a client scope (idempotency) + middleware_automation.keycloak.keycloak_userprofile: + state: present + parent_id: "{{ ephemeral_realm }}" + config: "{{ config_required_by_scope }}" + register: result + +- name: Assert the scoped requirement is in sync + ansible.builtin.assert: + that: + - result is not changed + - result.msg == "Userprofile declarative-user-profile was in sync" diff --git a/plugins/modules/keycloak_userprofile.py b/plugins/modules/keycloak_userprofile.py index c9bcbe4..efb50ad 100644 --- a/plugins/modules/keycloak_userprofile.py +++ b/plugins/modules/keycloak_userprofile.py @@ -257,6 +257,13 @@ options: default: - user + scopes: + description: + - The client scopes for which this attribute is required. + - If not set, the attribute is required regardless of the requested scopes. + type: list + elements: str + selector: description: - Selector when the attribute should be added. @@ -583,7 +590,11 @@ def main(): ), "multivalued": dict(type="bool", default=False), "required": dict( - type="dict", options={"roles": dict(type="list", elements="str", default=["user"])} + type="dict", + options={ + "roles": dict(type="list", elements="str", default=["user"]), + "scopes": dict(type="list", elements="str"), + }, ), "selector": dict(type="dict", options={"scopes": dict(type="list", elements="str")}), },