KEYCLOAK Declarative User Profile

November 14, 2024

Tags: #keycloak #oidc #authentication #userprofile #attributes #validation #video

Working with custom user attributes was in past Keycloak versions sometimes a bit cumbersome and difficult. Mostly, you were just able to have a field during registration or not, but the default account console didn’t show custom fields at all. This has changed with the declarative user profile, which has been introduced with Keycloak 24.x (before, it was already available as a preview feature with limited functionality).

The user profile allows you now to declare your custom user attributes by name, giving it language dependent labels, enable and require it either always or scope dependent. Additionally, you can set options for value selections, having input validations and also rendering attributes for a customized display and user experience.

The custom fields can be grouped, if desired, and they are being displayed by default in the admin UI, the account console and the registration form with the given annotations as text inputs, selects, radio buttons or checkboxes, etc.

Watch this video to see how it works and what to configure to be able to use it properly!

Don’t forget to subscribe to my YouTube channel!

Example sourcecodes (even if they are not used in this video) are available on my GitHub repository:

« KEYCLOAK Transient Users KEYCLOAK Persistent User Sessons »