Enum Class UserProfileContext

java.lang.Object
java.lang.Enum<UserProfileContext>
org.keycloak.userprofile.UserProfileContext
All Implemented Interfaces:
Serializable, Comparable<UserProfileContext>, Constable

public enum UserProfileContext extends Enum<UserProfileContext>

This interface represents the different contexts from where user profiles are managed. The core contexts are already available here representing the different parts in Keycloak where user profiles are managed.

The context is crucial to drive the conditions that should be respected when managing user profiles. It might be possible to include in the future metadata about contexts. As well as support custom contexts.

Author:
Markus Till
  • Enum Constant Details

  • Field Details

    • resetEmailVerified

      protected boolean resetEmailVerified
  • Method Details

    • values

      public static UserProfileContext[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static UserProfileContext valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • isResetEmailVerified

      public boolean isResetEmailVerified()
      Returns:
      true means that UserModel.emailVerified flag must be reset to false in this context when email address is updated