Uses of Interface
org.keycloak.models.RealmModel

Packages that use RealmModel

Package	Description
org.keycloak.component
org.keycloak.credential
org.keycloak.locale
org.keycloak.models
org.keycloak.models.credential
org.keycloak.models.utils
org.keycloak.policy
org.keycloak.services.clientpolicy
org.keycloak.sessions
org.keycloak.storage.client
org.keycloak.storage.clientscope
org.keycloak.storage.group
org.keycloak.storage.role
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	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	Description
CredentialValidationOutput	CredentialAuthentication.authenticate(RealmModel realm, CredentialInput input)
CredentialModel	CredentialProvider.createCredential(RealmModel realm, UserModel user, T credentialModel)
CredentialModel	UserCredentialStore.createCredential(RealmModel realm, UserModel user, CredentialModel cred)
boolean	CredentialProvider.deleteCredential(RealmModel realm, UserModel user, String credentialId)
void	CredentialInputUpdater.disableCredentialType(RealmModel realm, UserModel user, String credentialType)
default T	CredentialProvider.getDefaultCredential(KeycloakSession session, RealmModel realm, UserModel user)
Stream<String>	CredentialInputUpdater.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)	Obtains the set of credential types that can be disabled via disableCredentialType.
CredentialModel	UserCredentialStore.getStoredCredentialById(RealmModel realm, UserModel user, String id)
CredentialModel	UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type)
Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type)	Obtains the stored credentials associated with the specified user that match the specified type.
Stream<CredentialModel>	UserCredentialStore.getStoredCredentialsStream(RealmModel realm, UserModel user)	Obtains the stored credentials associated with the specified user.
boolean	CredentialInputValidator.isConfiguredFor(RealmModel realm, UserModel user, String credentialType)
boolean	CredentialInputValidator.isValid(RealmModel realm, UserModel user, CredentialInput credentialInput)	Tests whether a credential is valid
boolean	UserCredentialStore.moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId)
boolean	UserCredentialStore.removeStoredCredential(RealmModel realm, UserModel user, String id)	Removes credential with the id for the user.
boolean	CredentialInputUpdater.updateCredential(RealmModel realm, UserModel user, CredentialInput input)
void	UserCredentialStore.updateCredential(RealmModel realm, UserModel user, CredentialModel cred)

Uses of RealmModel in org.keycloak.locale

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

Modifier and Type	Method	Description
Locale	LocaleSelectorProvider.resolveLocale(RealmModel realm, UserModel user)	Resolve the locale which should be used for the request

Uses of RealmModel in org.keycloak.models

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

Modifier and Type	Field	Description
static SearchableModelField<RealmModel>	RealmModel.SearchableFields.CLIENT_INITIAL_ACCESS	Search for realms that have some client initial access set.
static Comparator<RealmModel>	RealmModel.COMPARE_BY_NAME
static SearchableModelField<RealmModel>	RealmModel.SearchableFields.COMPONENT_PROVIDER_TYPE	Search for realms that have some component with
static SearchableModelField<RealmModel>	RealmModel.SearchableFields.ID
static SearchableModelField<RealmModel>	RealmModel.SearchableFields.NAME
protected Supplier<RealmModel>	AbstractConfig.realm
protected Supplier<RealmModel>	AbstractConfig.realmForWrite

Methods in org.keycloak.models that return RealmModel

Modifier and Type	Method	Description
RealmModel	RealmProvider.createRealm(String name)	Creates new realm with the given name.
RealmModel	RealmProvider.createRealm(String id, String name)	Created new realm with given ID and name.
RealmModel	RealmModel.RealmCreationEvent.getCreatedRealm()
RealmModel	RealmModel.RealmPostCreateEvent.getCreatedRealm()
RealmModel	ClientModel.getRealm()
RealmModel	ClientScopeModel.getRealm()
RealmModel	GroupModel.GroupPathChangeEvent.getRealm()
RealmModel	GroupModel.GroupRemovedEvent.getRealm()
RealmModel	KeycloakContext.getRealm()
RealmModel	RealmModel.IdentityProviderRemovedEvent.getRealm()
RealmModel	RealmModel.IdentityProviderUpdatedEvent.getRealm()
RealmModel	RealmModel.RealmRemovedEvent.getRealm()
RealmModel	RealmProvider.getRealm(String id)	Exact search for a realm by its internal ID.
RealmModel	RoleModel.RoleNameChangeEvent.getRealm()
RealmModel	UserModel.UserRemovedEvent.getRealm()
RealmModel	UserSessionModel.getRealm()
RealmModel	RealmProvider.getRealmByName(String name)	Exact search for a realm by its name.

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

Modifier and Type	Method	Description
Stream<RealmModel>	RealmProvider.getRealmsStream()	Returns realms as a stream.
Stream<RealmModel>	RealmProvider.getRealmsWithProviderTypeStream(Class<?> type)	Returns stream of realms which has component with the given provider type.

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

Modifier and Type	Method	Description
default ClientModel	ClientProvider.addClient(RealmModel realm, String clientId)	Adds a client with given clientId to the given realm.
ClientModel	ClientProvider.addClient(RealmModel realm, String id, String clientId)	Adds a client with given internal ID and clientId to the given realm.
default ClientModel	RealmProvider.addClient(RealmModel realm, String clientId)	Deprecated. Use the corresponding method from ClientProvider.
ClientModel	RealmProvider.addClient(RealmModel realm, String id, String clientId)	Deprecated. Use the corresponding method from ClientProvider.
default RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String name)	Deprecated. Use the corresponding method from RoleProvider.
default RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String id, String name)	Deprecated. Use the corresponding method from RoleProvider.
default ClientScopeModel	ClientScopeProvider.addClientScope(RealmModel realm, String name)	Creates new client scope with given name to the given realm.
ClientScopeModel	ClientScopeProvider.addClientScope(RealmModel realm, String id, String name)	Creates new client scope with given internal ID and name to the given realm.
void	ClientProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)	Assign clientScopes to the client.
void	UserProvider.addConsent(RealmModel realm, String userId, UserConsentModel consent)	Add user consent for the user.
void	UserProvider.addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)	Adds a federated identity link for the user within the realm
default RoleModel	RealmProvider.addRealmRole(RealmModel realm, String name)	Deprecated. Use the corresponding method from RoleProvider.
RoleModel	RealmProvider.addRealmRole(RealmModel realm, String id, String name)	Deprecated. Use the corresponding method from RoleProvider.
default RoleModel	RoleProvider.addRealmRole(RealmModel realm, String name)	Adds a realm role with given name to the given realm.
RoleModel	RoleProvider.addRealmRole(RealmModel realm, String id, String name)	Adds a realm role with given internal ID and name to the given realm.
void	GroupProvider.addTopLevelGroup(RealmModel realm, GroupModel subGroup)	Removes parent group for the given group in the given realm.
void	RealmProvider.addTopLevelGroup(RealmModel realm, GroupModel subGroup)	Deprecated. Use the corresponding method from GroupProvider.
UserModel	UserProvider.addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)	Adds a new user into the storage.
UserLoginFailureModel	UserLoginFailureProvider.addUserLoginFailure(RealmModel realm, String userId)	Adds a UserLoginFailureModel for the given realm and user id.
CredentialValidationOutput	UserCredentialManager.authenticate(KeycloakSession session, RealmModel realm, CredentialInput input)	Deprecated. Given a CredentialInput, authenticate the user.
default ClientInitialAccessModel	RealmProvider.createClientInitialAccessModel(RealmModel realm, int expiration, int count)
AuthenticatedClientSessionModel	UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
CredentialModel	UserCredentialManager.createCredentialThroughProvider(RealmModel realm, UserModel user, CredentialModel model)	Deprecated. Creates a credential from the credentialModel, by looping through the providers to find a match for the type
default GroupModel	GroupProvider.createGroup(RealmModel realm, String name)	Creates a new group with the given name in the given realm.
default GroupModel	GroupProvider.createGroup(RealmModel realm, String id, String name)	Creates a new group with the given id and name in the given realm.
GroupModel	GroupProvider.createGroup(RealmModel realm, String id, String name, GroupModel toParent)	Creates a new group with the given name, id, name and parent to the given realm.
default GroupModel	GroupProvider.createGroup(RealmModel realm, String name, GroupModel toParent)	Creates a new group with the given name and parent to the given realm.
default GroupModel	RealmProvider.createGroup(RealmModel realm, String name)	Deprecated. Use the corresponding method from GroupProvider.
default GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name)	Deprecated. Use the corresponding method from GroupProvider.
GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name, GroupModel toParent)	Deprecated. Use the corresponding method from GroupProvider.
default GroupModel	RealmProvider.createGroup(RealmModel realm, String name, GroupModel toParent)	Deprecated. Use the corresponding method from GroupProvider.
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel	UserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
default void	RealmProvider.decreaseRemainingCount(RealmModel realm, ClientInitialAccessModel clientInitialAccess)
boolean	RealmProvider.deleteLocalizationText(RealmModel realm, String locale, String key)
boolean	RealmProvider.deleteLocalizationTextsByLocale(RealmModel realm, String locale)
void	UserCredentialManager.disableCredentialType(RealmModel realm, UserModel user, String credentialType)	Deprecated. Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through each CredentialProvider.
KeyManager.ActiveAesKey	KeyManager.getActiveAesKey(RealmModel realm)	Deprecated.
Map<String,Long>	UserSessionProvider.getActiveClientSessionStats(RealmModel realm, boolean offline)	Returns a summary of client sessions key is client.getId()
KeyManager.ActiveHmacKey	KeyManager.getActiveHmacKey(RealmModel realm)	Deprecated.
KeyWrapper	KeyManager.getActiveKey(RealmModel realm, KeyUse use, String algorithm)
KeyManager.ActiveRsaKey	KeyManager.getActiveRsaKey(RealmModel realm)	Deprecated.
long	UserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client)
List<SecretKeyMetadata>	KeyManager.getAesKeys(RealmModel realm)	Deprecated.
SecretKey	KeyManager.getAesSecretKey(RealmModel realm, String kid)	Deprecated.
Map<ClientModel,Set<String>>	ClientProvider.getAllRedirectUrisOfEnabledClients(RealmModel realm)	Deprecated. Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removal
Stream<ClientModel>	ClientProvider.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)	Returns a stream of clients that are expected to always show up in account console.
default ClientInitialAccessModel	RealmProvider.getClientInitialAccessModel(RealmModel realm, String id)
default RoleModel	RealmProvider.getClientRole(RealmModel realm, ClientModel client, String name)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default ClientScopeModel	RealmProvider.getClientScopeById(String id, RealmModel realm)	Deprecated. Use the corresponding method from ClientScopeProvider.
ClientScopeModel	RealmProvider.getClientScopeById(RealmModel realm, String id)	Deprecated. Use the corresponding method from ClientScopeProvider.
Stream<ClientScopeModel>	ClientScopeProvider.getClientScopesStream(RealmModel realm)	Returns all the client scopes of the given realm as a stream.
long	ClientProvider.getClientsCount(RealmModel realm)	Returns number of clients in the given realm
long	RealmProvider.getClientsCount(RealmModel realm)	Deprecated. Use the corresponding method from ClientProvider.
default Stream<ClientModel>	ClientProvider.getClientsStream(RealmModel realm)	Returns all the clients of the given realm as a stream.
Stream<ClientModel>	ClientProvider.getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)	Returns the clients of the given realm as a stream.
default Stream<String>	UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm, UserModel user)	Deprecated. Use UserModel.credentialManager() and then call SubjectCredentialManager.getConfiguredUserStorageCredentialTypesStream()
UserConsentModel	UserProvider.getConsentByClient(RealmModel realm, String userId, String clientInternalId)	Returns UserConsentModel given by a user with the userId for the client with clientInternalId
Stream<UserConsentModel>	UserProvider.getConsentsStream(RealmModel realm, String userId)	Obtains the consents associated with the user identified by the specified userId.
default Stream<String>	UserCredentialManager.getDisableableCredentialTypesStream(RealmModel realm, UserModel user)	Deprecated. Use UserModel.credentialManager() and then call SubjectCredentialManager.getDisableableCredentialTypesStream()
Stream<FederatedIdentityModel>	UserProvider.getFederatedIdentitiesStream(RealmModel realm, UserModel user)	Obtains the federated identities of the specified user.
FederatedIdentityModel	UserProvider.getFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)	Returns details of the association between the user and the socialProvider.
GroupModel	RealmProvider.getGroupById(RealmModel realm, String id)	Deprecated. Use the corresponding method from GroupProvider.
Stream<GroupModel>	GroupProvider.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)	Returns groups with the given role in the given realm.
Long	GroupProvider.getGroupsCount(RealmModel realm, Boolean onlyTopGroups)	Returns a number of groups/top level groups (i.e.
default Long	GroupProvider.getGroupsCount(RealmModel realm, Stream<String> ids, String search)	Returns a number of groups that contains the search string in the name
Long	RealmProvider.getGroupsCount(RealmModel realm, Boolean onlyTopGroups)	Deprecated. Use the corresponding method from GroupProvider.
Long	GroupProvider.getGroupsCountByNameContaining(RealmModel realm, String search)	Returns the number of top level groups containing groups with the given string in name for the given realm.
Long	RealmProvider.getGroupsCountByNameContaining(RealmModel realm, String search)	Deprecated. Use the corresponding method from GroupProvider.
Stream<GroupModel>	GroupProvider.getGroupsStream(RealmModel realm)	Returns groups for the given realm.
default Stream<GroupModel>	GroupProvider.getGroupsStream(RealmModel realm, Stream<String> ids)	Returns a stream of groups with given ids.
default Stream<GroupModel>	GroupProvider.getGroupsStream(RealmModel realm, Stream<String> ids, Integer first, Integer max)	Returns a paginated stream of groups with given ids.
Stream<GroupModel>	GroupProvider.getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)	Returns a paginated stream of groups with given ids and given search value in group names.
List<SecretKeyMetadata>	KeyManager.getHmacKeys(RealmModel realm)	Deprecated.
SecretKey	KeyManager.getHmacSecretKey(RealmModel realm, String kid)	Deprecated.
KeyWrapper	KeyManager.getKey(RealmModel realm, String kid, KeyUse use, String algorithm)
Stream<KeyWrapper>	KeyManager.getKeysStream(RealmModel realm)	Returns all KeyWrapper for the given realm.
Stream<KeyWrapper>	KeyManager.getKeysStream(RealmModel realm, KeyUse use, String algorithm)	Returns all KeyWrapper for the given realm that match given criteria.
String	OTPPolicy.getKeyURI(RealmModel realm, UserModel user, String secret)	Constructs the otpauth:// URI based on the Key-Uri-Format.
String	RealmProvider.getLocalizationTextsById(RealmModel realm, String locale, String key)
int	UserProvider.getNotBeforeOfUser(RealmModel realm, UserModel user)	Gets the notBefore value for the given user
long	UserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionModel	UserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	UserSessionProvider.getOfflineUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the offline user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)	Obtains the offline user sessions associated with the specified user.
RoleModel	RealmProvider.getRealmRole(RealmModel realm, String name)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.getRealmRoles(RealmModel realm, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Stream<RoleModel>	RoleProvider.getRealmRolesStream(RealmModel realm)	Returns all the realm roles of the given realm as a stream.
Stream<RoleModel>	RoleProvider.getRealmRolesStream(RealmModel realm, Integer first, Integer max)	Returns the realm roles of the given realm as a stream.
default RoleModel	RealmProvider.getRoleById(String id, RealmModel realm)	Deprecated. Use the corresponding method from RoleProvider.
Stream<RoleModel>	RoleProvider.getRolesStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)	Returns a paginated stream of roles with given ids and given search value in role names.
Certificate	KeyManager.getRsaCertificate(RealmModel realm, String kid)	Deprecated.
List<RsaKeyMetadata>	KeyManager.getRsaKeys(RealmModel realm)	Deprecated.
PublicKey	KeyManager.getRsaPublicKey(RealmModel realm, String kid)	Deprecated.
int	UserSessionProvider.getStartupTime(RealmModel realm)
Stream<GroupModel>	GroupProvider.getTopLevelGroupsStream(RealmModel realm)	Returns all top level groups (i.e.
Stream<GroupModel>	GroupProvider.getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)	Returns top level groups (i.e.
UserModel	UserProvider.getUserByFederatedIdentity(RealmModel realm, FederatedIdentityModel socialLink)	Returns a userModel that corresponds to the given socialLink.
UserLoginFailureModel	UserLoginFailureProvider.getUserLoginFailure(RealmModel realm, String userId)	Returns the UserLoginFailureModel for the given realm and user id.
UserSessionModel	UserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	UserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
Stream<UserSessionModel>	UserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the online user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)	Obtains the online user sessions associated with the specified client.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)	Obtains the online user sessions associated with the specified user.
UserSessionModel	UserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, boolean includeServiceAccounts)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map) with UserModel.INCLUDE_SERVICE_ACCOUNT within params instead.
default Stream<UserModel>	UserProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map, Integer, Integer) with UserModel.INCLUDE_SERVICE_ACCOUNT within params
boolean	UserCredentialManager.isConfiguredFor(RealmModel realm, UserModel user, String type)	Deprecated. Checks to see if user has credential type configured.
boolean	UserCredentialManager.isConfiguredLocally(RealmModel realm, UserModel user, String type)	Deprecated. Only loops through each CredentialProvider to see if credential type is configured for the user.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, List<CredentialInput> inputs)	Deprecated. Validates list of credentials.
boolean	UserCredentialManager.isValid(RealmModel realm, UserModel user, CredentialInput... inputs)	Deprecated. Validates list of credentials.
default Stream<ClientInitialAccessModel>	RealmProvider.listClientInitialAccessStream(RealmModel realm)	Returns client's initial access as a stream.
void	GroupProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)	This method is used for moving groups in group structure, for example: making an existing child group child group of some other group, setting a top level group (i.e.
void	RealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)	Deprecated. Use the corresponding method from GroupProvider.
void	UserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)
void	UserSessionProvider.onRealmRemoved(RealmModel realm)
void	UserProvider.preRemove(RealmModel realm)	Called when a realm is removed.
void	UserProvider.preRemove(RealmModel realm, ComponentModel component)	Called when a component is removed.
void	UserProvider.preRemove(RealmModel realm, ClientModel client)	Called when a client is removed.
void	UserProvider.preRemove(RealmModel realm, GroupModel group)	Called when a group is removed.
void	UserProvider.preRemove(RealmModel realm, IdentityProviderModel provider)	Called when an identity provider is removed.
void	UserProvider.preRemove(RealmModel realm, RoleModel role)	Called when a role is removed.
void	UserLoginFailureProvider.removeAllUserLoginFailures(RealmModel realm)	Removes all the UserLoginFailureModel for the given realm.
boolean	ClientProvider.removeClient(RealmModel realm, String id)	Removes given client from the given realm.
default void	RealmProvider.removeClientInitialAccessModel(RealmModel realm, String id)
void	ClientProvider.removeClients(RealmModel realm)	Removes all clients from the given realm.
void	ClientProvider.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)	Unassign clientScope from the client.
boolean	ClientScopeProvider.removeClientScope(RealmModel realm, String id)	Removes client scope from the given realm.
void	ClientScopeProvider.removeClientScopes(RealmModel realm)	Removes all client scopes from the given realm.
void	UserSessionProvider.removeExpired(RealmModel realm)	Removes expired user sessions owned by this realm from this provider.
boolean	UserProvider.removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)	Removes federation link between the user and the identity provider given by its id
boolean	GroupProvider.removeGroup(RealmModel realm, GroupModel group)	Removes the given group for the given realm.
boolean	RealmProvider.removeGroup(RealmModel realm, GroupModel group)	Deprecated. Use the corresponding method from GroupProvider.
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
default boolean	RealmProvider.removeRole(RealmModel realm, RoleModel role)	Deprecated. Use the corresponding method from RoleProvider.
void	RoleProvider.removeRoles(RealmModel realm)	Removes all roles from the given realm.
boolean	UserManager.removeUser(RealmModel realm, UserModel user)
boolean	UserManager.removeUser(RealmModel realm, UserModel user, UserProvider userProvider)
void	UserLoginFailureProvider.removeUserLoginFailure(RealmModel realm, String userId)	Removes a UserLoginFailureModel for the given realm and user id.
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)	Remove a user consent given by the user id and client id
void	RealmProvider.saveLocalizationText(RealmModel realm, String locale, String key, String text)
void	RealmProvider.saveLocalizationTexts(RealmModel realm, String locale, Map<String,String> localizationTexts)
default Set<RoleModel>	RealmProvider.searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
default Set<RoleModel>	RealmProvider.searchForRoles(RealmModel realm, String search, Integer first, Integer max)	Deprecated. Use the corresponding method from RoleProvider.
void	UserProvider.setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)	Sets the notBefore value for the given user
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)	Update client scopes in the stored user consent
boolean	UserCredentialManager.updateCredential(RealmModel realm, UserModel user, CredentialInput input)	Deprecated. Updates a credential.
void	UserCredentialManager.updateCredentialLabel(RealmModel realm, UserModel user, String credentialId, String userLabel)	Deprecated. Updates the credential label and invalidates the cache for the user.
void	UserProvider.updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)	Update details of association between the federatedUser and the idp given by the federatedIdentityModel
boolean	RealmProvider.updateLocalizationText(RealmModel realm, String locale, String key, String text)
void	IdentityProviderModel.validate(RealmModel realm)	Validates this configuration.

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

Constructor	Description
CibaConfig(RealmModel realm)
OAuth2DeviceConfig(RealmModel realm)
ParConfig(RealmModel realm)

Uses of RealmModel in org.keycloak.models.credential

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

Modifier and Type	Method	Description
static OTPCredentialModel	OTPCredentialModel.createFromPolicy(RealmModel realm, String secretValue)
static OTPCredentialModel	OTPCredentialModel.createFromPolicy(RealmModel realm, String secretValue, String userLabel)

Uses of RealmModel in org.keycloak.models.utils

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

Modifier and Type	Method	Description
static boolean	RoleUtils.isRealmRole(RoleModel r, RealmModel realm)

Uses of RealmModel in org.keycloak.policy

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

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

Uses of RealmModel in org.keycloak.services.clientpolicy

Methods in org.keycloak.services.clientpolicy with parameters of type RealmModel

Modifier and Type	Method	Description
ClientPoliciesRepresentation	ClientPolicyManager.getClientPolicies(RealmModel realm)	when getting client policies via Admin REST API, returns the existing client policies set on the realm.
ClientProfilesRepresentation	ClientPolicyManager.getClientProfiles(RealmModel realm, boolean includeGlobalProfiles)	when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.
void	ClientPolicyManager.setupClientPoliciesOnCreatedRealm(RealmModel realm)	when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute.
void	ClientPolicyManager.updateClientPolicies(RealmModel realm, ClientPoliciesRepresentation clientPolicies)	when updating client policies via Admin REST API, reads the json representation of the client policies and overrides the existing client policies set on the realm with them.
void	ClientPolicyManager.updateClientProfiles(RealmModel realm, ClientProfilesRepresentation clientProfiles)	when updating client profiles via Admin REST API, reads the json representation of the client profiles and overrides the existing client profiles set on the realm with them.
void	ClientPolicyManager.updateRealmModelFromRepresentation(RealmModel realm, RealmRepresentation rep)	when importing a realm, or updating a realm, update model from the representation object
void	ClientPolicyManager.updateRealmRepresentationFromModel(RealmModel realm, RealmRepresentation rep)	when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies.

Uses of RealmModel in org.keycloak.sessions

Methods in org.keycloak.sessions that return RealmModel

Modifier and Type	Method	Description
RealmModel	CommonClientSessionModel.getRealm()
RealmModel	RootAuthenticationSessionModel.getRealm()	Returns realm associated to the root authentication session.

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

Modifier and Type	Method	Description
RootAuthenticationSessionModel	AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm)	Creates and registers a new authentication session with random ID.
RootAuthenticationSessionModel	AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm, String id)	Creates a new root authentication session specified by the provided realm and id.
RootAuthenticationSessionModel	AuthenticationSessionProvider.getRootAuthenticationSession(RealmModel realm, String authenticationSessionId)	Returns the root authentication session specified by the provided realm and id.
void	AuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)	Removes all associated root authentication sessions to the given realm and client which was removed.
void	AuthenticationSessionProvider.onRealmRemoved(RealmModel realm)	Removes all associated root authentication sessions to the given realm which was removed.
void	AuthenticationSessionProvider.removeExpired(RealmModel realm)	Deprecated. manual removal of expired entities should not be used anymore.
void	AuthenticationSessionProvider.removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)	Removes provided root authentication session.
void	RootAuthenticationSessionModel.restartSession(RealmModel realm)	Will completely restart whole state of authentication session.

Uses of RealmModel in org.keycloak.storage.client

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

Modifier and Type	Method	Description
ClientModel	ClientLookupProvider.getClientByClientId(RealmModel realm, String clientId)	Exact search for a client by its public client identifier.
ClientModel	ClientLookupProvider.getClientById(RealmModel realm, String id)	Exact search for a client by its internal ID.
Map<String,ClientScopeModel>	ClientLookupProvider.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)	Return all default scopes (if defaultScope is true) or all optional scopes (if defaultScope is false) linked with the client
Stream<ClientModel>	ClientLookupProvider.searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	ClientLookupProvider.searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)	Case-insensitive search for clients that contain the given string in their public client identifier.

Uses of RealmModel in org.keycloak.storage.clientscope

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

Modifier and Type	Method	Description
ClientScopeModel	ClientScopeLookupProvider.getClientScopeById(RealmModel realm, String id)	Exact search for a client scope by its internal ID..

Uses of RealmModel in org.keycloak.storage.group

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

Modifier and Type	Method	Description
GroupModel	GroupLookupProvider.getGroupById(RealmModel realm, String id)	Returns a group from the given realm with the corresponding id
Stream<GroupModel>	GroupLookupProvider.searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)	Returns the group hierarchy with the given string in name for the given realm.
default Stream<GroupModel>	GroupLookupProvider.searchForGroupByNameStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)	Deprecated. Use GroupLookupProvider.searchForGroupByNameStream(RealmModel, String, Boolean, Integer, Integer) instead.
Stream<GroupModel>	GroupLookupProvider.searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)	Returns the groups filtered by attribute names and attribute values for the given realm.

Uses of RealmModel in org.keycloak.storage.role

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

Modifier and Type	Method	Description
RoleModel	RoleLookupProvider.getRealmRole(RealmModel realm, String name)	Exact search for a role by given name.
RoleModel	RoleLookupProvider.getRoleById(RealmModel realm, String id)	Exact search for a role by its internal ID..
Stream<RoleModel>	RoleLookupProvider.searchForRolesStream(RealmModel realm, String search, Integer first, Integer max)	Case-insensitive search for roles that contain the given string in their name or description.

Uses of RealmModel in org.keycloak.storage.user

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

Modifier and Type	Method	Description
UserModel	UserRegistrationProvider.addUser(RealmModel realm, String username)	All storage providers that implement this interface will be looped through.
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group)	Obtains users that belong to a specific group.
Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role)	Obtains users that have the specified role.
default Stream<UserModel>	UserQueryProvider.getRoleMembersStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)	Searches for users that have the specified role.
default CredentialValidationOutput	UserLookupProvider.getUserByCredential(RealmModel realm, CredentialInput input)
UserModel	UserLookupProvider.getUserByEmail(RealmModel realm, String email)	Returns a user with the given email belonging to the realm
UserModel	UserLookupProvider.getUserById(RealmModel realm, String id)	Returns a user with the given id belonging to the realm
UserModel	UserLookupProvider.getUserByUsername(RealmModel realm, String username)	Exact search for a user by its username.
default int	UserQueryProvider.getUsersCount(RealmModel realm)	Returns the number of users, without consider any service account.
default int	UserQueryProvider.getUsersCount(RealmModel realm, boolean includeServiceAccount)	Returns the number of users.
default int	UserQueryProvider.getUsersCount(RealmModel realm, String search)	Returns the number of users that would be returned by a call to searchForUserStream
default int	UserQueryProvider.getUsersCount(RealmModel realm, String search, Set<String> groupIds)	Returns the number of users that would be returned by a call to searchForUserStream and are members of at least one of the groups given by the groupIds set.
default int	UserQueryProvider.getUsersCount(RealmModel realm, Map<String,String> params)	Returns the number of users that match the given filter parameters.
default int	UserQueryProvider.getUsersCount(RealmModel realm, Map<String,String> params, Set<String> groupIds)	Returns the number of users that match the given filter parameters and is in at least one of the given groups.
default int	UserQueryProvider.getUsersCount(RealmModel realm, Set<String> groupIds)	Returns the number of users that are in at least one of the groups given.
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map) with an empty params map instead.
default Stream<UserModel>	UserQueryProvider.getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults)	Deprecated. Use UserQueryProvider.searchForUserStream(RealmModel, Map, Integer, Integer) with an empty params map instead.
void	UserBulkUpdateProvider.grantToAllUsers(RealmModel realm, RoleModel role)	Grants the given role to all users from particular realm.
boolean	UserRegistrationProvider.removeUser(RealmModel realm, UserModel user)	Called if user originated from this provider.
Stream<UserModel>	UserQueryProvider.searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue)	Searches for users that have a specific attribute with a specific value.
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search)	Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)	Searches for users whose username, email, first name or last name contain any of the strings in search separated by whitespace.
default Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params)	Searches for user by parameter.
Stream<UserModel>	UserQueryProvider.searchForUserStream(RealmModel realm, Map<String,String> params, Integer firstResult, Integer maxResults)	Searches for user by parameter.