keycloak-group-by-domain/README.md
Cédric Couralet ac8ab8b623 Add the list of authorized mails in registration forms
This work by adding the `authorizedMailDomains` attribute in the form before displaying it.
2021-04-14 22:13:03 +02:00

1.2 KiB

Keycloak - Whitelist email domain for registration

This extension allows you to validate email domain used for registration in keycloak to accept only a finite list of domain.

You can use basic glob syntax (only * and ? are supported)

How to install

Simply drop the jar in $KEYCLOAK_HOME\standalone\deployments, it will be automatically deployed by keycloak.

How to use

  • Go to the admin console, in authentication menu.
  • Copy the registration flow
  • add a new execution below "Profile Validation" and choose "Profile Validation With Email Domain Check"
  • Configure this new execution (otherwise, keycloak will only accept "exemple.org" domains)
  • Change the registration binding to this new flow
  • Configure the realm to accept registration and verify email (this is important!)

Display authorized mail domains in register forms

This extension provides the list of authorized patterns in the authorizedMailDomains attribute of the registration page.

This can be used like this :

 <div class="${properties.kcLabelWrapperClass!}">
                    <label for="email" class="${properties.kcLabelClass!}">${msg("email")} (only ${authorizedMailDomains?join(", ")})</label>
 </div>