Uses of Interface
org.keycloak.models.RealmModel

Packages that use RealmModel

Package	Description
org.keycloak.component
org.keycloak.credential
org.keycloak.models
org.keycloak.models.cache
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.sessions
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.federated
org.keycloak.storage.user

Uses of RealmModel in org.keycloak.component

Methods in org.keycloak.component with parameters of type RealmModel

Modifier and Type	Method and Description
default List<ProviderConfigProperty>	SubComponentFactory.getConfigProperties(RealmModel realm, ComponentModel parent)
default Map<String,Object>	SubComponentFactory.getTypeMetadata(RealmModel realm, ComponentModel parent) This is metadata about this component type.
default void	ComponentFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called after a component is created
default void	ComponentFactory.onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) Called after the component is updated.
default void	ComponentFactory.preRemove(KeycloakSession session, RealmModel realm, ComponentModel model) Called before the component is removed.
default void	ComponentFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) Called before a component is created or updated.

Uses of RealmModel in org.keycloak.credential

Methods in org.keycloak.credential with parameters of type RealmModel

Modifier and Type	Method and Description
CredentialValidationOutput	CredentialAuthentication.authenticate(RealmModel realm, CredentialInput input)
CredentialModel	UserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
void	CredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
Set<String>	CredentialInputUpdater.getDisableableCredentialTypes(RealmModel realm, UserModel user) Returns a set of credential types that can be disabled by disableCredentialType() method
CredentialModel	UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
List<CredentialModel>	UserCredentialStore.getStoredCredentials(RealmModel realm, UserModel user)
List<CredentialModel>	UserCredentialStore.getStoredCredentialsByType(RealmModel realm, UserModel user, String type)
boolean	CredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	CredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput input)
boolean	UserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)
boolean	CredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	UserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)

Uses of RealmModel in org.keycloak.models

Methods in org.keycloak.models that return RealmModel

Modifier and Type	Method and Description
RealmModel	RealmProvider.createRealm(String name)
RealmModel	RealmProvider.createRealm(String id, String name)
RealmModel	RealmModel.RealmCreationEvent.getCreatedRealm()
RealmModel	RealmModel.RealmPostCreateEvent.getCreatedRealm()
RealmModel	KeycloakContext.getRealm()
RealmModel	UserModel.UserRemovedEvent.getRealm()
RealmModel	UserSessionModel.getRealm()
RealmModel	ClientTemplateModel.getRealm()
RealmModel	GroupModel.GroupRemovedEvent.getRealm()
RealmModel	RealmModel.RealmRemovedEvent.getRealm()
RealmModel	RealmModel.IdentityProviderUpdatedEvent.getRealm()
RealmModel	RealmModel.IdentityProviderRemovedEvent.getRealm()
RealmModel	ClientModel.getRealm()
RealmModel	RealmProvider.getRealm(String id)
RealmModel	RealmProvider.getRealmByName(String name)

Methods in org.keycloak.models that return types with arguments of type RealmModel

Modifier and Type	Method and Description
List<RealmModel>	RealmProvider.getRealms()

Methods in org.keycloak.models with parameters of type RealmModel

Modifier and Type	Method and Description
ClientModel	RealmProvider.addClient(RealmModel realm, String clientId)
ClientModel	RealmProvider.addClient(RealmModel realm, String id, String clientId)
RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String name)
RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String id, String name)
void	UserProvider.addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	UserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
RoleModel	RealmProvider.addRealmRole(RealmModel realm, String name)
RoleModel	RealmProvider.addRealmRole(RealmModel realm, String id, String name)
void	RealmProvider.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
UserModel	UserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions) only used for local storage
UserLoginFailureModel	UserSessionProvider.addUserLoginFailure(RealmModel realm, String userId)
CredentialValidationOutput	UserCredentialManager.authenticate(KeycloakSession session, RealmModel realm, CredentialInput input) Given a CredentialInput, authenticate the user.
ClientInitialAccessModel	RealmProvider.createClientInitialAccessModel(RealmModel realm, int expiration, int count)
AuthenticatedClientSessionModel	UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
GroupModel	RealmProvider.createGroup(RealmModel realm, String name)
GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name)
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void	RealmProvider.decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess)
void	UserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType) Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
KeyManager.ActiveHmacKey	KeyManager.getActiveHmacKey(RealmModel realm)
KeyManager.ActiveRsaKey	KeyManager.getActiveRsaKey(RealmModel realm)
long	UserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client)
ClientModel	RealmProvider.getClientByClientId(String clientId, RealmModel realm)
ClientModel	RealmProvider.getClientById(String id, RealmModel realm)
ClientInitialAccessModel	RealmProvider.getClientInitialAccessModel(RealmModel realm, String id)
RoleModel	RealmProvider.getClientRole(RealmModel realm, ClientModel client, String name)
Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client)
List<ClientModel>	RealmProvider.getClients(RealmModel realm)
ClientTemplateModel	RealmProvider.getClientTemplateById(String id, RealmModel realm)
UserConsentModel	UserProvider.getConsentByClient(RealmModel realm, String userId, String clientInternalId)
List<UserConsentModel>	UserProvider.getConsents(RealmModel realm, String userId)
Set<String>	UserCredentialManager.getDisableableCredentialTypes(RealmModel realm, UserModel user) Returns a set of credential types that can be disabled by disableCredentialType() method
Set<FederatedIdentityModel>	UserProvider.getFederatedIdentities(UserModel user, RealmModel realm)
FederatedIdentityModel	UserProvider.getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
GroupModel	RealmProvider.getGroupById(String id, RealmModel realm)
List<GroupModel>	RealmProvider.getGroups(RealmModel realm)
List<HmacKeyMetadata>	KeyManager.getHmacKeys(RealmModel realm, boolean includeDisabled)
SecretKey	KeyManager.getHmacSecretKey(RealmModel realm, String kid)
String	OTPPolicy.getKeyURI(RealmModel realm, UserModel user, String secret) Constructs the otpauth:// URI based on the Key-Uri-Format.
long	UserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionModel	UserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId)
List<UserSessionModel>	UserSessionProvider.getOfflineUserSessions(RealmModel realm, ClientModel client, int first, int max)
List<UserSessionModel>	UserSessionProvider.getOfflineUserSessions(RealmModel realm, UserModel user)
RoleModel	RealmProvider.getRealmRole(RealmModel realm, String name)
Set<RoleModel>	RealmProvider.getRealmRoles(RealmModel realm)
RoleModel	RealmProvider.getRoleById(String id, RealmModel realm)
Certificate	KeyManager.getRsaCertificate(RealmModel realm, String kid)
List<RsaKeyMetadata>	KeyManager.getRsaKeys(RealmModel realm, boolean includeDisabled)
PublicKey	KeyManager.getRsaPublicKey(RealmModel realm, String kid)
List<GroupModel>	RealmProvider.getTopLevelGroups(RealmModel realm)
UserModel	UserProvider.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
UserLoginFailureModel	UserSessionProvider.getUserLoginFailure(RealmModel realm, String userId)
List<UserModel>	UserProvider.getUsers(RealmModel realm, boolean includeServiceAccounts)
List<UserModel>	UserProvider.getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
UserSessionModel	UserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	UserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
List<UserSessionModel>	UserSessionProvider.getUserSessionByBrokerUserId(RealmModel realm, String brokerUserId)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, ClientModel client)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, ClientModel client, int firstResult, int maxResults)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, UserModel user)
boolean	UserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type) Checks to see if user has credential type configured.
boolean	UserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type) Only loops through each CredentialProvider to see if credential type is configured for the user.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs) Validates list of credentials.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs) Validates list of credentials.
List<ClientInitialAccessModel>	RealmProvider.listClientInitialAccess(RealmModel realm)
void	RealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	UserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)
void	UserSessionProvider.onRealmRemoved(RealmModel realm)
void	UserProvider.preRemove(RealmModel realm)
void	UserProvider.preRemove(RealmModel realm, ClientModel client)
void	UserProvider.preRemove(RealmModel realm, ComponentModel component)
void	UserProvider.preRemove(RealmModel realm, GroupModel group)
void	UserProvider.preRemove(RealmModel realm, RoleModel role)
void	UserSessionProvider.removeAllUserLoginFailures(RealmModel realm)
boolean	RealmProvider.removeClient(String id, RealmModel realm)
void	RealmProvider.removeClientInitialAccessModel(RealmModel realm, String id)
void	UserSessionProvider.removeExpired(RealmModel realm) Implementation should propagate removal of expired userSessions to userSessionPersister too
boolean	UserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
boolean	RealmProvider.removeGroup(RealmModel realm, GroupModel group)
void	UserProvider.removeImportedUsers(RealmModel realm, String storageProviderId) Removes any imported users from a specific User Storage Provider.
void	UserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) Removes the attached clientSessions as well
boolean	RealmProvider.removeRole(RealmModel realm, RoleModel role)
boolean	UserManager.removeUser(RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider)
void	UserSessionProvider.removeUserLoginFailure(RealmModel realm, String userId)
void	UserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session) This will remove attached ClientLoginSessionModels too
void	UserSessionProvider.removeUserSessions(RealmModel realm)
void	UserSessionProvider.removeUserSessions(RealmModel realm, UserModel user)
void	UserSessionModel.restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
boolean	UserProvider.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
void	KeycloakContext.setRealm(RealmModel realm)
void	UserProvider.unlinkUsers(RealmModel realm, String storageProviderId) Set federation link to null to imported users of a specific User Storage Provider
void	UserProvider.updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	UserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input) Updates a credential.
void	UserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)

Uses of RealmModel in org.keycloak.models.cache

Methods in org.keycloak.models.cache with parameters of type RealmModel

Modifier and Type	Method and Description
void	UserCache.evict(RealmModel realm) Evict users of a specific realm
void	UserCache.evict(RealmModel realm, UserModel user) Evict user from cache.
void	OnUserCache.onCache(RealmModel realm, CachedUserModel user, UserModel delegate)

Uses of RealmModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils with parameters of type RealmModel

Modifier and Type	Method and Description
static void	DefaultRoles.addDefaultRoles(RealmModel realm, UserModel userModel)
static Set<RoleModel>	DefaultRoles.getDefaultRoles(RealmModel realm)

Uses of RealmModel in org.keycloak.policy

Methods in org.keycloak.policy with parameters of type RealmModel

Modifier and Type	Method and Description
PolicyError	PasswordPolicyProvider.validate(RealmModel realm, UserModel user, String password)

Uses of RealmModel in org.keycloak.sessions

Methods in org.keycloak.sessions that return RealmModel

Modifier and Type	Method and Description
RealmModel	CommonClientSessionModel.getRealm()

Methods in org.keycloak.sessions with parameters of type RealmModel

Modifier and Type	Method and Description
AuthenticationSessionModel	AuthenticationSessionProvider.createAuthenticationSession(RealmModel realm, ClientModel client)
AuthenticationSessionModel	AuthenticationSessionProvider.createAuthenticationSession(String id, RealmModel realm, ClientModel client)
AuthenticationSessionModel	AuthenticationSessionProvider.getAuthenticationSession(RealmModel realm, String authenticationSessionId)
void	AuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)
void	AuthenticationSessionProvider.onRealmRemoved(RealmModel realm)
void	AuthenticationSessionProvider.removeAuthenticationSession(RealmModel realm, AuthenticationSessionModel authenticationSession)
void	AuthenticationSessionProvider.removeExpired(RealmModel realm)
void	AuthenticationSessionModel.restartSession(RealmModel realm, ClientModel client)

Uses of RealmModel in org.keycloak.storage

Methods in org.keycloak.storage with parameters of type RealmModel

Modifier and Type	Method and Description
default void	UserStorageProviderFactory.onCreate(KeycloakSession session, RealmModel realm, ComponentModel model) Called when UserStorageProviderModel is created.
default void	UserStorageProvider.preRemove(RealmModel realm) Callback when a realm is removed.
default void	UserStorageProvider.preRemove(RealmModel realm, GroupModel group) Callback when a group is removed.
default void	UserStorageProvider.preRemove(RealmModel realm, RoleModel role) Callback when a role is removed.
default void	UserStorageProviderFactory.validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config)

Uses of RealmModel in org.keycloak.storage.adapter

Fields in org.keycloak.storage.adapter declared as RealmModel

Modifier and Type	Field and Description
protected RealmModel	AbstractUserAdapter.realm
protected RealmModel	AbstractUserAdapterFederatedStorage.realm

Constructors in org.keycloak.storage.adapter with parameters of type RealmModel

Constructor and Description
AbstractUserAdapter(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)
AbstractUserAdapterFederatedStorage(KeycloakSession session, RealmModel realm, ComponentModel storageProviderModel)

Uses of RealmModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated with parameters of type RealmModel

Modifier and Type	Method and Description
void	UserConsentFederatedStorage.addConsent(RealmModel realm, String userId, UserConsentModel consent)
void	UserBrokerLinkFederatedStorage.addFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel socialLink)
void	UserRequiredActionsFederatedStorage.addRequiredAction(RealmModel realm, String userId, String action)
CredentialModel	UserFederatedUserCredentialStore.createCredential(RealmModel realm, String userId, CredentialModel cred)
void	UserRoleMappingsFederatedStorage.deleteRoleMapping(RealmModel realm, String userId, RoleModel role)
org.keycloak.common.util.MultivaluedHashMap<String,String>	UserAttributeFederatedStorage.getAttributes(RealmModel realm, String userId)
UserConsentModel	UserConsentFederatedStorage.getConsentByClient(RealmModel realm, String userId, String clientInternalId)
List<UserConsentModel>	UserConsentFederatedStorage.getConsents(RealmModel realm, String userId)
Set<FederatedIdentityModel>	UserBrokerLinkFederatedStorage.getFederatedIdentities(String userId, RealmModel realm)
FederatedIdentityModel	UserBrokerLinkFederatedStorage.getFederatedIdentity(String userId, String socialProvider, RealmModel realm)
Set<GroupModel>	UserGroupMembershipFederatedStorage.getGroups(RealmModel realm, String userId)
List<String>	UserGroupMembershipFederatedStorage.getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
Set<String>	UserRequiredActionsFederatedStorage.getRequiredActions(RealmModel realm, String userId)
Set<RoleModel>	UserRoleMappingsFederatedStorage.getRoleMappings(RealmModel realm, String userId)
CredentialModel	UserFederatedUserCredentialStore.getStoredCredentialById(RealmModel realm, String userId, String id)
CredentialModel	UserFederatedUserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, String userId, String name, String type)
List<CredentialModel>	UserFederatedUserCredentialStore.getStoredCredentials(RealmModel realm, String userId)
List<CredentialModel>	UserFederatedUserCredentialStore.getStoredCredentialsByType(RealmModel realm, String userId, String type)
List<String>	UserFederatedStorageProvider.getStoredUsers(RealmModel realm, int first, int max)
int	UserFederatedStorageProvider.getStoredUsersCount(RealmModel realm)
String	UserBrokerLinkFederatedStorage.getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
List<String>	UserAttributeFederatedStorage.getUsersByUserAttribute(RealmModel realm, String name, String value)
void	UserRoleMappingsFederatedStorage.grantRole(RealmModel realm, String userId, RoleModel role)
void	UserGroupMembershipFederatedStorage.joinGroup(RealmModel realm, String userId, GroupModel group)
void	UserGroupMembershipFederatedStorage.leaveGroup(RealmModel realm, String userId, GroupModel group)
void	UserFederatedStorageProvider.preRemove(RealmModel realm)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, ClientModel client)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, ComponentModel model)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, GroupModel group)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, RoleModel role)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, UserModel user)
void	UserAttributeFederatedStorage.removeAttribute(RealmModel realm, String userId, String name)
boolean	UserBrokerLinkFederatedStorage.removeFederatedIdentity(RealmModel realm, String userId, String socialProvider)
void	UserRequiredActionsFederatedStorage.removeRequiredAction(RealmModel realm, String userId, String action)
boolean	UserFederatedUserCredentialStore.removeStoredCredential(RealmModel realm, String userId, String id)
boolean	UserConsentFederatedStorage.revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
void	UserAttributeFederatedStorage.setAttribute(RealmModel realm, String userId, String name, List<String> values)
void	UserAttributeFederatedStorage.setSingleAttribute(RealmModel realm, String userId, String name, String value)
void	UserConsentFederatedStorage.updateConsent(RealmModel realm, String userId, UserConsentModel consent)
void	UserFederatedUserCredentialStore.updateCredential(RealmModel realm, String userId, CredentialModel cred)
void	UserBrokerLinkFederatedStorage.updateFederatedIdentity(RealmModel realm, String userId, FederatedIdentityModel federatedIdentityModel)

Uses of RealmModel in org.keycloak.storage.user

Methods in org.keycloak.storage.user with parameters of type RealmModel

Modifier and Type	Method and Description
UserModel	UserRegistrationProvider.addUser(RealmModel realm, String username) All storage providers that implement this interface will be looped through.
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group) Get users that belong to a specific group.
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Get users that belong to a specific group.
UserModel	UserLookupProvider.getUserByEmail(String email, RealmModel realm)
UserModel	UserLookupProvider.getUserById(String id, RealmModel realm)
UserModel	UserLookupProvider.getUserByUsername(String username, RealmModel realm)
List<UserModel>	UserQueryProvider.getUsers(RealmModel realm)
List<UserModel>	UserQueryProvider.getUsers(RealmModel realm, int firstResult, int maxResults)
int	UserQueryProvider.getUsersCount(RealmModel realm)
void	UserBulkUpdateProvider.grantToAllUsers(RealmModel realm, RoleModel role)
boolean	UserRegistrationProvider.removeUser(RealmModel realm, UserModel user) Called if user originated from this provider.
List<UserModel>	UserQueryProvider.searchForUser(Map<String,String> params, RealmModel realm) Search for user by parameter.
List<UserModel>	UserQueryProvider.searchForUser(Map<String,String> params, RealmModel realm, int firstResult, int maxResults) Search for user by parameter.
List<UserModel>	UserQueryProvider.searchForUser(String search, RealmModel realm) Search for users with username, email or first + last name that is like search string.
List<UserModel>	UserQueryProvider.searchForUser(String search, RealmModel realm, int firstResult, int maxResults) Search for users with username, email or first + last name that is like search string.
List<UserModel>	UserQueryProvider.searchForUserByUserAttribute(String attrName, String attrValue, RealmModel realm) Search for users that have a specific attribute with a specific value.
UserModel	ImportedUserValidation.validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removed