How to dynamically set keycloak theme from the URL?

Question

I am been looking at keycloak documentation, and while I have figured out how to create custom login pages, I can not seem to find the way to send information to keycloak, in the url, about what theme to use. I have a dark theme and a light theme on my website, and I want it so that when the user goes to keycloak from either dark mode or light mode, that keycloak page matches what is from my website. The only thing I found was about some argument to pass in the url of kc_theme='name of theme', but that does not seem to be working.

"http://localhost:8081/realms/customer-portal/protocol/openid-connect/auth?client_id=customer-portal&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fapi%2Flogin-callback&response_type=code&scope=openid&login_theme=my-dark-theme&prompt=login".

What can I do to fix this?

Marcus Hert da Coregio · Accepted Answer · 2025-09-03 11:24:50Z

0

You should implement the ThemeSelectorProvider and ThemeSelectorProviderFactory SPIs, and then add an entry of the factory to the resources/META-INF/org.keycloak.theme.ThemeSelectorProviderFactory file.

In addition to that, you must enable and tell Keycloak that you want to use your custom implementation as a provider, so, when you invoke your kc.sh you should pass additional arguments, like:

kc.sh build --spi-theme-selector--my-theme-selector-provider--enabled=true --spi-theme-selector--provider=my-theme-selector-provider

You can find more details in the official docs.

answered Sep 3 at 11:24

Marcus Hert da Coregio

6,4881 gold badge20 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to dynamically set keycloak theme from the URL?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related