Custom OIDC identity provider - GUI presents very limited fields #35605

kamilaprz · 2024-12-04T14:00:01Z

kamilaprz
Dec 4, 2024

Hello everyone,

We are working with Keycloak v25.0.6.

We have developed custom identity providers in our system, extending KeycloakOIDCIdentityProvider and KeycloakOIDCIdentityProviderFactory.

However, we've noticed an issue when adding a new identity provider of these types in the Admin UI. The interface presents only a very limited set of fields:

Redirect URI
Client ID
Client Secret
Display Order

These custom providers are intended to have the same properties as KeycloakOIDCIdentityProvider, functioning as generic OIDC providers with additional functionality layered on top.

The IDs for these providers are as following convention:

{custom-prefix}-oidc-{specific-suffix}
{custom-prefix}-oidc

I looked briefly at those resources:
https://github.com/keycloak/keycloak/blob/main/js/apps/admin-ui/src/identity-providers/add/DetailSettings.tsx#L406

and
https://github.com/keycloak/keycloak/blob/main/js/apps/admin-ui/src/identity-providers/add/AddOpenIdConnect.tsxL82

I would expect, at the very least, the ability to edit the alias for a new provider.

Here is an example code snippet for the custom identity provider implementation:

@MetaInfServices(IdentityProviderFactory.class)
public class CustomOidcProviderFactory extends KeycloakOIDCIdentityProviderFactory {
    public static final String PROVIDER_ID = "custom-oidc";
    private static final String PROVIDER_DESC = "Custom OpenID Connect";

    @Override
    public String getId() {
        return PROVIDER_ID;
    }

    @Override
    public String getName() {
        return PROVIDER_DESC;
    }

    @Override
    public KeycloakOIDCIdentityProvider create(KeycloakSession session, IdentityProviderModel model) {
        return new CustomOidcProvider(session, new OIDCIdentityProviderConfig(model));
    }
}

public class CustomOidcProvider extends KeycloakOIDCIdentityProvider {

    public CustomOidcProvider(KeycloakSession session, OIDCIdentityProviderConfig config) {
        super(session, config);
    }

    @Override
    public BrokeredIdentityContext getFederatedIdentity(String response) {
        // do something extra
        return context;
    }
}

This is problematic because we plan to have multiple identity providers of the same type. As you know, the alias for an identity provider must be unique, is included in the redirect URI, and cannot be changed after creation of new identity provider.

Is there something in our implementation or configuration that we might be missing to enable the full set of fields, including alias, to appear? Any insights would be greatly appreciated.

Thank you!

Aldisti · 2025-06-07T16:02:35Z

Aldisti
Jun 7, 2025

I was trying to create a new OIDC Provider that just added a query param to the authorize request.
Initially I did that by extending the OIDCIdentityProvider class but the generated GUI was different than the default OIDC.

In the end, I replaced the provider id custom-oidc with oidc. This way I got all the OIDC configurations, but I overrided the default OIDC provider.

But, I think this could be improved...

0 replies

Navigation Menu

Repository navigation

Custom OIDC identity provider - GUI presents very limited fields #35605

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Custom OIDC identity provider - GUI presents very limited fields #35605

Uh oh!

kamilaprz Dec 4, 2024

Replies: 1 comment

Uh oh!

Uh oh!

Aldisti Jun 7, 2025

kamilaprz
Dec 4, 2024

Aldisti
Jun 7, 2025