Package org.keycloak.wellknown

Interface WellKnownProviderFactory

All Superinterfaces:
org.keycloak.provider.ProviderFactory<WellKnownProvider>
All Known Implementing Classes:
JWTVCIssuerWellKnownProviderFactory, OAuth2WellKnownProviderFactory, OID4VCIssuerWellKnownProviderFactory, OIDCWellKnownProviderFactory, UmaWellKnownProviderFactory
public interface WellKnownProviderFactory extends org.keycloak.provider.ProviderFactory<WellKnownProvider>
Author:
Stian Thorgersen

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getAlias()
    Alias, which will be used as URL suffix of this well-known provider.
    default int
    getPriority()
    Use low priority, so custom implementation with alias "openid-configuration" will win over the default implementation with alias "openid-configuration", which is provided by Keycloak (OIDCWellKnownProviderFactory).
    default boolean
    isAvailableViaServerMetadata()
    Controls if the WellKnownProvider is available via server metadata endpoint.

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    close, create, dependsOn, getConfigMetadata, getId, init, order, postInit

  • Method Details

    • getAlias

      default String getAlias()
      Alias, which will be used as URL suffix of this well-known provider. For example if you use alias like "openid-configuration", then your WellKnown provider might be available under URL like "https://myhost/auth/realms/myrealm/.well-known/openid-configuration". If there are multiple provider factories with same alias, the one with lowest priority will be used.
      See Also:

    • getPriority

      default int getPriority()
      Use low priority, so custom implementation with alias "openid-configuration" will win over the default implementation with alias "openid-configuration", which is provided by Keycloak (OIDCWellKnownProviderFactory).

    • isAvailableViaServerMetadata

      default boolean isAvailableViaServerMetadata()
      Controls if the WellKnownProvider is available via server metadata endpoint. If this method returns true, then the provider will be available under /.well-known/{alias}/realms/{realm}, where {alias} is the well-known alias returned by getAlias(). Default implementation returns false.
      Returns:
      true if this provider may be exposed via ServerMetadataResource