Access to group attributes in custom email template

florinr · September 6, 2021, 9:30am

Is it possible to display in a custom email template information coming from attributes defined at group level? I’m trying to implement a Welcome email message in which I need to access information defined at group level. For this I have customized executeActions.ftl. I was able to access attributes defined at user level using <#assign attributes = user.getAttributes()>. The user is associated with a group where more attributes are defined. No attributes defined at group level are present in the user.getAttributes(). Thank you.

xgp · September 6, 2021, 10:01am

You’ll have to override the provider that sets up the .ftl context as well. As you can see in the current provider, the only things in the executeActions email are the ProfileBean and realm name:

github.com

keycloak/keycloak/blob/master/services/src/main/java/org/keycloak/email/freemarker/FreeMarkerEmailTemplateProvider.java#L158

    
      
              idpAlias = ObjectUtil.capitalize(idpAlias);
          
          
    attributes.put("identityProviderContext", brokerContext);
              attributes.put("identityProviderAlias", idpAlias);
          
          
    List<Object> subjectAttrs = Arrays.asList(idpAlias);
              send("identityProviderLinkSubject", subjectAttrs, "identity-provider-link.ftl", attributes);
          }
          
          
@Override
          public void sendExecuteActions(String link, long expirationInMinutes) throws EmailException {
              Map<String, Object> attributes = new HashMap<>(this.attributes);
              attributes.put("user", new ProfileBean(user));
              addLinkInfoIntoAttributes(link, expirationInMinutes, attributes);
          
          
    attributes.put("realmName", getRealmName());
          
          
    send("executeActionsSubject", "executeActions.ftl", attributes);
          }
          
          
@Override

Topic		Replies	Views
Not able to customize email template contents in keycloak v20.0.1	2	1642	December 9, 2022
How to access OIDC client information in E-Mail templates?	1	693	December 21, 2021
Different subjects for verification and password reset emails Extending the server	0	730	June 15, 2021
Add realm-name in email themes Configuring the server	4	6326	March 6, 2020
Not able to send welcoming email after successful registration Configuring the server	5	3474	May 28, 2021

Access to group attributes in custom email template

Related Topics