Package org.keycloak.broker.provider

Interface IdentityProvider<C extends IdentityProviderModel>

All Superinterfaces:
Provider
All Known Subinterfaces:
ClientAssertionIdentityProvider<C>, JWTAuthorizationGrantProvider<C>, SocialIdentityProvider<C>, UserAuthenticationIdentityProvider<C>
All Known Implementing Classes:
AbstractIdentityProvider, AbstractOAuth2IdentityProvider, BitbucketIdentityProvider, FacebookIdentityProvider, GitHubIdentityProvider, GitLabIdentityProvider, GoogleIdentityProvider, InstagramIdentityProvider, JWTAuthorizationGrantIdentityProvider, KeycloakOIDCIdentityProvider, KubernetesIdentityProvider, LinkedInOIDCIdentityProvider, MicrosoftIdentityProvider, OAuth2IdentityProvider, OIDCIdentityProvider, OpenshiftV4IdentityProvider, PayPalIdentityProvider, SAMLIdentityProvider, SpiffeIdentityProvider, StackoverflowIdentityProvider, TwitterIdentityProvider
public interface IdentityProvider<C extends IdentityProviderModel> extends Provider
Author:
Pedro Igor

  • Method Summary

    Modifier and Type
    Method
    Description
    default jakarta.ws.rs.core.Response
    export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format)
    Export a representation of the IdentityProvider in a specific format.
    C
    getConfig()
     
    default boolean
    isMapperSupported(IdentityProviderMapper mapper)
    Checks whether a mapper is supported for this Identity Provider.
    default boolean
    isType(KeycloakSession session, IdentityProviderType type)
    Returns if this Identity Provider is of the passed type.
    default boolean
    reloadKeys()
    Reload keys for the identity provider if permitted in it.For example OIDC or SAML providers will reload the keys from the jwks or metadata endpoint.

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • getConfig

      C getConfig()

    • export

      default jakarta.ws.rs.core.Response export(jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, String format)
      Export a representation of the IdentityProvider in a specific format. For example, a SAML EntityDescriptor
      Returns:

    • isMapperSupported

      default boolean isMapperSupported(IdentityProviderMapper mapper)
      Checks whether a mapper is supported for this Identity Provider.

    • reloadKeys

      default boolean reloadKeys()
      Reload keys for the identity provider if permitted in it.For example OIDC or SAML providers will reload the keys from the jwks or metadata endpoint.
      Returns:
      true if reloaded, false if not

    • isType

      default boolean isType(KeycloakSession session, IdentityProviderType type)
      Returns if this Identity Provider is of the passed type. By default it just returns true when it implements the correct interface. Sub-classes like the OIDC provider can check specific configuration options.
      Parameters:
      session - The helper session
      type - The type to check
      Returns:
      true if the provider is of the passed type, false otherwise