Package org.keycloak.authentication.requiredactions

Class UpdateEmail

java.lang.Object
org.keycloak.authentication.requiredactions.UpdateEmail
All Implemented Interfaces:
org.keycloak.authentication.RequiredActionFactory, org.keycloak.authentication.RequiredActionProvider, org.keycloak.provider.EnvironmentDependentProviderFactory, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
public class UpdateEmail extends Object implements org.keycloak.authentication.RequiredActionProvider, org.keycloak.authentication.RequiredActionFactory, org.keycloak.provider.EnvironmentDependentProviderFactory

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIG_VERIFY_EMAIL
     
    static final String
    EMAIL_RESEND_COOLDOWN_KEY_PREFIX
     

    Fields inherited from interface org.keycloak.authentication.RequiredActionFactory

    MAX_AUTH_AGE_CONFIG_PROPERTIES

  • Constructor Summary

    Constructors
    Constructor
    Description
    UpdateEmail()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    org.keycloak.authentication.RequiredActionProvider
    create(org.keycloak.models.KeycloakSession session)
     
    void
    evaluateTriggers(org.keycloak.authentication.RequiredActionContext context)
     
    static void
    forceEmailVerification(org.keycloak.models.KeycloakSession session)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigMetadata()
     
    String
    getDisplayText()
     
    String
    getId()
     
    void
    init(org.keycloak.Config.Scope config)
     
    org.keycloak.authentication.InitiatedActionSupport
    initiatedActionSupport()
     
    static boolean
    isEnabled(org.keycloak.models.RealmModel realm)
     
    boolean
    isSupported(org.keycloak.Config.Scope config)
     
    static boolean
    isVerifyEmailEnabled(org.keycloak.models.RealmModel realm)
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    void
    processAction(org.keycloak.authentication.RequiredActionContext context)
     
    void
    requiredActionChallenge(org.keycloak.authentication.RequiredActionContext context)
     
    static void
    updateEmailNow(org.keycloak.events.EventBuilder event, org.keycloak.models.UserModel user, org.keycloak.userprofile.UserProfile emailUpdateValidationResult)
     
    static org.keycloak.userprofile.UserProfile
    validateEmailUpdate(org.keycloak.models.KeycloakSession session, org.keycloak.models.UserModel user, String newEmail)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, order

    Methods inherited from interface org.keycloak.authentication.RequiredActionFactory

    isConfigurable, isOneTimeAction, validateConfig

    Methods inherited from interface org.keycloak.authentication.RequiredActionProvider

    getMaxAuthAge, getMaxAuthAge, initiatedActionCanceled

  • Field Details

  • Constructor Details

    • UpdateEmail

      public UpdateEmail()

  • Method Details

    • isEnabled

      public static boolean isEnabled(org.keycloak.models.RealmModel realm)

    • isVerifyEmailEnabled

      public static boolean isVerifyEmailEnabled(org.keycloak.models.RealmModel realm)

    • forceEmailVerification

      public static void forceEmailVerification(org.keycloak.models.KeycloakSession session)

    • initiatedActionSupport

      public org.keycloak.authentication.InitiatedActionSupport initiatedActionSupport()
      Specified by:
      initiatedActionSupport in interface org.keycloak.authentication.RequiredActionProvider

    • getDisplayText

      public String getDisplayText()
      Specified by:
      getDisplayText in interface org.keycloak.authentication.RequiredActionFactory

    • evaluateTriggers

      public void evaluateTriggers(org.keycloak.authentication.RequiredActionContext context)
      Specified by:
      evaluateTriggers in interface org.keycloak.authentication.RequiredActionProvider

    • requiredActionChallenge

      public void requiredActionChallenge(org.keycloak.authentication.RequiredActionContext context)
      Specified by:
      requiredActionChallenge in interface org.keycloak.authentication.RequiredActionProvider

    • processAction

      public void processAction(org.keycloak.authentication.RequiredActionContext context)
      Specified by:
      processAction in interface org.keycloak.authentication.RequiredActionProvider

    • validateEmailUpdate

      public static org.keycloak.userprofile.UserProfile validateEmailUpdate(org.keycloak.models.KeycloakSession session, org.keycloak.models.UserModel user, String newEmail)

    • updateEmailNow

      public static void updateEmailNow(org.keycloak.events.EventBuilder event, org.keycloak.models.UserModel user, org.keycloak.userprofile.UserProfile emailUpdateValidationResult)

    • create

      public org.keycloak.authentication.RequiredActionProvider create(org.keycloak.models.KeycloakSession session)
      Specified by:
      create in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • init

      public void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • postInit

      public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.Provider
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • getId

      public String getId()
      Specified by:
      getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>

    • getConfigMetadata

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigMetadata()
      Specified by:
      getConfigMetadata in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.RequiredActionProvider>
      Specified by:
      getConfigMetadata in interface org.keycloak.authentication.RequiredActionFactory

    • isSupported

      public boolean isSupported(org.keycloak.Config.Scope config)
      Specified by:
      isSupported in interface org.keycloak.provider.EnvironmentDependentProviderFactory