Package org.keycloak.protocol

Interface LoginProtocolFactory

All Superinterfaces:
org.keycloak.provider.ProviderFactory<LoginProtocol>
All Known Implementing Classes:
AbstractLoginProtocolFactory
public interface LoginProtocolFactory extends org.keycloak.provider.ProviderFactory<LoginProtocol>
Version:
$Revision: 1 $
Author:
Bill Burke

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClientScopeDefaults(org.keycloak.representations.idm.ClientScopeRepresentation clientScope)
    Add default values to ClientScopeRepresentations that refer to the specific login-protocol
    default boolean
    allowAsClientProtocol()
    Returns whether this protocol can be used as a client protocol.
    void
    createDefaultClientScopes(org.keycloak.models.RealmModel newRealm, boolean addScopesToExistingClients)
    Called when new realm is created
    Object
    createProtocolEndpoint(org.keycloak.models.KeycloakSession session, EventBuilder event)
     
    Map<String,org.keycloak.models.ProtocolMapperModel>
    getBuiltinMappers()
    List of built in protocol mappers that can be used to apply to clients.
    default boolean
    isValidClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client, org.keycloak.models.ClientScopeModel clientScope)
    Test if the clientScope is valid for particular client.
    default void
    onConsentRevoked(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client, org.keycloak.models.UserModel user)
    Callback method invoked when consent of specified user is being revoked for the specified client
    void
    setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient)
    Setup default values for new clients.
    default void
    validateClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.representations.idm.ClientScopeRepresentation clientScope)
    Invoked during client-scope creation or update to add additional validation hooks specific to target protocol.
    default void
    validateClientScopeAssignment(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientScopeModel clientScope, boolean defaultScope, org.keycloak.models.RealmModel realm)
    Validates whether a client scope can be assigned as Default or Optional to a client or realm.

    Methods inherited from interface org.keycloak.provider.ProviderFactory

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

  • Method Details

    • getBuiltinMappers

      Map<String,org.keycloak.models.ProtocolMapperModel> getBuiltinMappers()
      List of built in protocol mappers that can be used to apply to clients.
      Returns:

    • createProtocolEndpoint

      Object createProtocolEndpoint(org.keycloak.models.KeycloakSession session, EventBuilder event)

    • createDefaultClientScopes

      void createDefaultClientScopes(org.keycloak.models.RealmModel newRealm, boolean addScopesToExistingClients)
      Called when new realm is created
      Parameters:
      newRealm -
      addScopesToExistingClients - If true, then existing realm clients will be updated (created realm default scopes will be added to them)

    • setupClientDefaults

      void setupClientDefaults(org.keycloak.representations.idm.ClientRepresentation rep, org.keycloak.models.ClientModel newClient)
      Setup default values for new clients. This expects that the representation has already set up the client
      Parameters:
      rep -
      newClient -

    • addClientScopeDefaults

      void addClientScopeDefaults(org.keycloak.representations.idm.ClientScopeRepresentation clientScope)
      Add default values to ClientScopeRepresentations that refer to the specific login-protocol

    • validateClientScope

      default void validateClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.representations.idm.ClientScopeRepresentation clientScope) throws jakarta.ws.rs.WebApplicationException
      Invoked during client-scope creation or update to add additional validation hooks specific to target protocol. May throw errorResponseException in case
      Parameters:
      session - Keycloak session
      clientScope - client scope to create or update
      Throws:
      jakarta.ws.rs.WebApplicationException - or some of it's subclass if validation fails

    • isValidClientScope

      default boolean isValidClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client, org.keycloak.models.ClientScopeModel clientScope)
      Test if the clientScope is valid for particular client. Usually called during protocol requests

    • validateClientScopeAssignment

      default void validateClientScopeAssignment(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientScopeModel clientScope, boolean defaultScope, org.keycloak.models.RealmModel realm)
      Validates whether a client scope can be assigned as Default or Optional to a client or realm. This method is called before assigning a client scope to ensure protocol-specific restrictions are enforced.
      Parameters:
      session - the Keycloak session
      clientScope - the client scope to be assigned
      defaultScope - true if assigning as Default scope, false if Optional
      realm - the realm where the assignment is happening
      Throws:
      jakarta.ws.rs.BadRequestException - if the assignment is not allowed

    • allowAsClientProtocol

      default boolean allowAsClientProtocol()
      Returns whether this protocol can be used as a client protocol.
      Returns:
      true if the protocol can be used for clients, false otherwise

    • onConsentRevoked

      default void onConsentRevoked(org.keycloak.models.KeycloakSession session, org.keycloak.models.ClientModel client, org.keycloak.models.UserModel user)
      Callback method invoked when consent of specified user is being revoked for the specified client
      Parameters:
      session - Keycloak session
      client - Client
      user - user