Package org.keycloak.models
Interface UserModel
-
- All Superinterfaces:
RoleMapperModel
- All Known Subinterfaces:
CachedUserModel
,CachedUserModel.Streams
,UserModel.Streams
- All Known Implementing Classes:
AbstractUserAdapter
,AbstractUserAdapter.Streams
,AbstractUserAdapterFederatedStorage
,AbstractUserAdapterFederatedStorage.Streams
,AbstractUserModel
,GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate
,InMemoryUserAdapter
,LDAPWritesOnlyUserModelDelegate
,MapUserAdapter
,MSADLDSUserAccountControlStorageMapper.MSADUserModelDelegate
,MSADUserAccountControlStorageMapper.MSADUserModelDelegate
,ReadOnlyKerberosUserModelDelegate
,ReadonlyLDAPUserModelDelegate
,ReadonlySSSDUserModelDelegate
,ReadOnlyUserModelDelegate
,RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate
,TxAwareLDAPUserModelDelegate
,UpdateOnlyChangeUserModelDelegate
,UserAdapter
,UserAdapter
,UserModelDefaultMethods
,UserModelDefaultMethods.Streams
,UserModelDelegate
public interface UserModel extends RoleMapperModel
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
UserModel.RequiredAction
static class
UserModel.SearchableFields
static interface
UserModel.Streams
Deprecated.This interface is no longer necessary, collection-based methods were removed from the parent interface and therefore the parent interface can be used directlystatic interface
UserModel.UserRemovedEvent
-
Field Summary
Fields Modifier and Type Field Description static Comparator<UserModel>
COMPARE_BY_USERNAME
static String
DISABLED_REASON
static String
EMAIL
static String
EMAIL_VERIFIED
static String
ENABLED
static String
EXACT
static String
FIRST_NAME
static String
GROUPS
static String
IDP_ALIAS
static String
IDP_USER_ID
static String
INCLUDE_SERVICE_ACCOUNT
static String
LAST_NAME
static String
LOCALE
static String
SEARCH
static String
USERNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description void
addRequiredAction(String action)
default void
addRequiredAction(UserModel.RequiredAction action)
SubjectCredentialManager
credentialManager()
Instance of a user credential manager to validate and update the credentials of this user.Map<String,List<String>>
getAttributes()
Stream<String>
getAttributeStream(String name)
Obtains all values associated with the specified attribute name.Long
getCreatedTimestamp()
Get timestamp of user creation.String
getEmail()
String
getFederationLink()
String
getFirstAttribute(String name)
String
getFirstName()
default long
getGroupsCount()
default long
getGroupsCountByNameContaining(String search)
Stream<GroupModel>
getGroupsStream()
Obtains the groups associated with the user.default Stream<GroupModel>
getGroupsStream(String search, Integer first, Integer max)
Returns a paginated stream of groups within this realm with search in the nameString
getId()
String
getLastName()
Stream<String>
getRequiredActionsStream()
Obtains the names of required actions associated with the user.String
getServiceAccountClientLink()
String
getUsername()
boolean
isEmailVerified()
boolean
isEnabled()
boolean
isMemberOf(GroupModel group)
void
joinGroup(GroupModel group)
void
leaveGroup(GroupModel group)
void
removeAttribute(String name)
void
removeRequiredAction(String action)
default void
removeRequiredAction(UserModel.RequiredAction action)
void
setAttribute(String name, List<String> values)
void
setCreatedTimestamp(Long timestamp)
void
setEmail(String email)
Sets email for this user.void
setEmailVerified(boolean verified)
void
setEnabled(boolean enabled)
void
setFederationLink(String link)
void
setFirstName(String firstName)
void
setLastName(String lastName)
void
setServiceAccountClientLink(String clientInternalId)
void
setSingleAttribute(String name, String value)
Set single value of specified attribute.void
setUsername(String username)
Sets username for this user.-
Methods inherited from interface org.keycloak.models.RoleMapperModel
deleteRoleMapping, getClientRoleMappingsStream, getRealmRoleMappingsStream, getRoleMappingsStream, grantRole, hasDirectRole, hasRole
-
-
-
-
Field Detail
-
USERNAME
static final String USERNAME
- See Also:
- Constant Field Values
-
FIRST_NAME
static final String FIRST_NAME
- See Also:
- Constant Field Values
-
LAST_NAME
static final String LAST_NAME
- See Also:
- Constant Field Values
-
EMAIL
static final String EMAIL
- See Also:
- Constant Field Values
-
EMAIL_VERIFIED
static final String EMAIL_VERIFIED
- See Also:
- Constant Field Values
-
LOCALE
static final String LOCALE
- See Also:
- Constant Field Values
-
ENABLED
static final String ENABLED
- See Also:
- Constant Field Values
-
IDP_ALIAS
static final String IDP_ALIAS
- See Also:
- Constant Field Values
-
IDP_USER_ID
static final String IDP_USER_ID
- See Also:
- Constant Field Values
-
INCLUDE_SERVICE_ACCOUNT
static final String INCLUDE_SERVICE_ACCOUNT
- See Also:
- Constant Field Values
-
GROUPS
static final String GROUPS
- See Also:
- Constant Field Values
-
SEARCH
static final String SEARCH
- See Also:
- Constant Field Values
-
EXACT
static final String EXACT
- See Also:
- Constant Field Values
-
DISABLED_REASON
static final String DISABLED_REASON
- See Also:
- Constant Field Values
-
COMPARE_BY_USERNAME
static final Comparator<UserModel> COMPARE_BY_USERNAME
-
-
Method Detail
-
getId
String getId()
-
getUsername
String getUsername()
-
setUsername
void setUsername(String username)
Sets username for this user. No default method here to allow Abstract subclasses where the username is provided in a different manner- Parameters:
username
- username string
-
getCreatedTimestamp
Long getCreatedTimestamp()
Get timestamp of user creation. May be null for old users created before this feature introduction.
-
setCreatedTimestamp
void setCreatedTimestamp(Long timestamp)
-
isEnabled
boolean isEnabled()
-
setEnabled
void setEnabled(boolean enabled)
-
setSingleAttribute
void setSingleAttribute(String name, String value)
Set single value of specified attribute. Remove all other existing values of this attribute- Parameters:
name
-value
-
-
removeAttribute
void removeAttribute(String name)
-
getFirstAttribute
String getFirstAttribute(String name)
- Parameters:
name
-- Returns:
- null if there is not any value of specified attribute or first value otherwise. Don't throw exception if there are more values of the attribute
-
getAttributeStream
Stream<String> getAttributeStream(String name)
Obtains all values associated with the specified attribute name.- Parameters:
name
- the name of the attribute.- Returns:
- a non-null
Stream
of attribute values.
-
getRequiredActionsStream
Stream<String> getRequiredActionsStream()
Obtains the names of required actions associated with the user.- Returns:
- a non-null
Stream
of required action names.
-
addRequiredAction
void addRequiredAction(String action)
-
removeRequiredAction
void removeRequiredAction(String action)
-
addRequiredAction
default void addRequiredAction(UserModel.RequiredAction action)
-
removeRequiredAction
default void removeRequiredAction(UserModel.RequiredAction action)
-
getFirstName
String getFirstName()
-
setFirstName
void setFirstName(String firstName)
-
getLastName
String getLastName()
-
setLastName
void setLastName(String lastName)
-
getEmail
String getEmail()
-
setEmail
void setEmail(String email)
Sets email for this user.- Parameters:
email
- the email
-
isEmailVerified
boolean isEmailVerified()
-
setEmailVerified
void setEmailVerified(boolean verified)
-
getGroupsStream
Stream<GroupModel> getGroupsStream()
Obtains the groups associated with the user.- Returns:
- a non-null
Stream
of groups.
-
getGroupsStream
default Stream<GroupModel> getGroupsStream(String search, Integer first, Integer max)
Returns a paginated stream of groups within this realm with search in the name- Parameters:
search
- Case insensitive string which will be searched for. Ignored if null.first
- Index of first group to return. Ignored if negative ornull
.max
- Maximum number of records to return. Ignored if negative ornull
.- Returns:
- Stream of desired groups. Never returns
null
.
-
getGroupsCount
default long getGroupsCount()
-
getGroupsCountByNameContaining
default long getGroupsCountByNameContaining(String search)
-
joinGroup
void joinGroup(GroupModel group)
-
leaveGroup
void leaveGroup(GroupModel group)
-
isMemberOf
boolean isMemberOf(GroupModel group)
-
getFederationLink
String getFederationLink()
-
setFederationLink
void setFederationLink(String link)
-
getServiceAccountClientLink
String getServiceAccountClientLink()
-
setServiceAccountClientLink
void setServiceAccountClientLink(String clientInternalId)
-
credentialManager
SubjectCredentialManager credentialManager()
Instance of a user credential manager to validate and update the credentials of this user.
-
-