Uses of Interface
org.keycloak.models.GroupModel

Packages that use GroupModel

Package	Description
org.keycloak.models
org.keycloak.models.utils
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.group
org.keycloak.storage.user

Uses of GroupModel in org.keycloak.models

Subinterfaces of GroupModel in org.keycloak.models

Modifier and Type	Interface	Description
static interface	GroupModel.Streams	The GroupModel.Streams interface makes all collection-based methods in GroupModel default by providing implementations that delegate to the Stream-based variants instead of the other way around.

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

Modifier and Type	Field	Description
static SearchableModelField<GroupModel>	GroupModel.SearchableFields.ASSIGNED_ROLE	Field for comparison with roles granted to this group.
static Comparator<GroupModel>	GroupModel.COMPARE_BY_NAME
static SearchableModelField<GroupModel>	GroupModel.SearchableFields.ID
static SearchableModelField<GroupModel>	GroupModel.SearchableFields.NAME
static SearchableModelField<GroupModel>	GroupModel.SearchableFields.PARENT_ID	Parent group ID
static SearchableModelField<GroupModel>	GroupModel.SearchableFields.REALM_ID

Methods in org.keycloak.models that return GroupModel

Modifier and Type	Method	Description
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	RealmModel.createGroup(String name)
default GroupModel	RealmModel.createGroup(String id, String name)
GroupModel	RealmModel.createGroup(String id, String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String name, GroupModel toParent)
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.
GroupModel	GroupModel.GroupRemovedEvent.getGroup()
default GroupModel	GroupProvider.getGroupById(String id, RealmModel realm)	Deprecated. Use method getGroupById
GroupModel	RealmModel.getGroupById(String id)
default GroupModel	RealmProvider.getGroupById(String id, RealmModel realm)	Deprecated. Use the corresponding method from GroupProvider.
GroupModel	RealmProvider.getGroupById(RealmModel realm, String id)	Deprecated. Use the corresponding method from GroupProvider.
GroupModel	GroupModel.getParent()

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

Modifier and Type	Method	Description
default List<GroupModel>	RealmModel.getDefaultGroups()	Deprecated. Use getDefaultGroupsStream instead.
Stream<GroupModel>	RealmModel.getDefaultGroupsStream()	Returns default groups as a stream.
default List<GroupModel>	GroupProvider.getGroups(RealmModel realm)	Deprecated. Use getGroupsStream instead.
default List<GroupModel>	RealmModel.getGroups()	Deprecated. Use getGroupsStream instead.
default List<GroupModel>	RealmProvider.getGroups(RealmModel realm)	Deprecated. Use the corresponding method from GroupProvider.
Set<GroupModel>	UserModel.getGroups()	Deprecated. Use getGroupsStream instead.
default Set<GroupModel>	UserModel.getGroups(int first, int max)	Deprecated. Use getGroupsStream instead.
default Set<GroupModel>	UserModel.getGroups(String search, int first, int max)	Deprecated. Use getGroupsStream instead.
default Set<GroupModel>	UserModel.Streams.getGroups()
default List<GroupModel>	GroupProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)	Deprecated. Use getGroupsByRoleStream instead.
default List<GroupModel>	RealmProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)	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.
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.
Stream<GroupModel>	RealmModel.getGroupsStream()	Returns groups as a stream.
default Stream<GroupModel>	UserModel.getGroupsStream()	Obtains the groups associated with the user.
default Stream<GroupModel>	UserModel.getGroupsStream(String search, Integer first, Integer max)	Returns a paginated stream of groups within this realm with search in the name
Stream<GroupModel>	UserModel.Streams.getGroupsStream()
Set<GroupModel>	GroupModel.getSubGroups()	Deprecated. Use getSubGroupsStream instead.
default Set<GroupModel>	GroupModel.Streams.getSubGroups()
default Stream<GroupModel>	GroupModel.getSubGroupsStream()	Returns all sub groups for the parent group as a stream.
Stream<GroupModel>	GroupModel.Streams.getSubGroupsStream()
default List<GroupModel>	GroupProvider.getTopLevelGroups(RealmModel realm)	Deprecated. Use getTopLevelGroupsStream instead.
default List<GroupModel>	GroupProvider.getTopLevelGroups(RealmModel realm, Integer firstResult, Integer maxResults)	Deprecated. Use getTopLevelGroupsStream instead.
default List<GroupModel>	RealmModel.getTopLevelGroups()	Deprecated. Use getTopLevelGroups instead.
default List<GroupModel>	RealmModel.getTopLevelGroups(Integer first, Integer max)	Deprecated. Use getTopLevelGroupsStream instead.
default List<GroupModel>	RealmProvider.getTopLevelGroups(RealmModel realm)	Deprecated. Use the corresponding method from GroupProvider.
default List<GroupModel>	RealmProvider.getTopLevelGroups(RealmModel realm, Integer first, Integer max)	Deprecated. Use the corresponding method from GroupProvider.
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.
Stream<GroupModel>	RealmModel.getTopLevelGroupsStream()	Returns top level groups as a stream.
Stream<GroupModel>	RealmModel.getTopLevelGroupsStream(Integer first, Integer max)	Returns top level groups as a stream.
default List<GroupModel>	RealmModel.searchForGroupByName(String search, Integer first, Integer max)	Deprecated. Use searchForGroupByName instead.
default List<GroupModel>	RealmProvider.searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)	Deprecated. Use the corresponding method from GroupProvider.
Stream<GroupModel>	RealmModel.searchForGroupByNameStream(String search, Integer first, Integer max)	Searches for groups by provided name.

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

Modifier and Type	Method	Description
void	GroupModel.addChild(GroupModel subGroup)	Automatically calls setParent() on the subGroup
void	RealmModel.addDefaultGroup(GroupModel group)
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.
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.
GroupModel	RealmModel.createGroup(String id, String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String name, GroupModel toParent)
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.
boolean	UserModel.isMemberOf(GroupModel group)
void	UserModel.joinGroup(GroupModel group)
void	UserModel.leaveGroup(GroupModel group)
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	RealmModel.moveGroup(GroupModel group, GroupModel toParent)
void	RealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)	Deprecated. Use the corresponding method from GroupProvider.
void	UserProvider.preRemove(RealmModel realm, GroupModel group)	Called when a group is removed.
void	GroupModel.removeChild(GroupModel subGroup)	Automatically calls setParent() on the subGroup
void	RealmModel.removeDefaultGroup(GroupModel group)
boolean	GroupProvider.removeGroup(RealmModel realm, GroupModel group)	Removes the given group for the given realm.
boolean	RealmModel.removeGroup(GroupModel group)
boolean	RealmProvider.removeGroup(RealmModel realm, GroupModel group)	Deprecated. Use the corresponding method from GroupProvider.
void	GroupModel.setParent(GroupModel group)	You must also call addChild on the parent group, addChild on RealmModel if there is no parent group

Uses of GroupModel in org.keycloak.models.utils

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

Modifier and Type	Method	Description
Stream<GroupModel>	UserModelDelegate.getGroupsStream()

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

Modifier and Type	Method	Description
static boolean	RoleUtils.hasRoleFromGroup(GroupModel group, RoleModel targetRole, boolean checkParentGroup)	Checks whether the targetRole is contained in the given group or its parents (if requested)
static boolean	RoleUtils.isMember(Set<GroupModel> groups, GroupModel targetGroup)	Deprecated. Use RoleUtils.isMember(Stream, GroupModel) isMember(Stream, GroupModel)} instead.
static boolean	RoleUtils.isMember(Stream<GroupModel> groups, GroupModel targetGroup)
boolean	UserModelDelegate.isMemberOf(GroupModel group)
void	UserModelDelegate.joinGroup(GroupModel group)
void	UserModelDelegate.leaveGroup(GroupModel group)

Method parameters in org.keycloak.models.utils with type arguments of type GroupModel

Modifier and Type	Method	Description
static boolean	RoleUtils.hasRoleFromGroup(Iterable<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup)	Deprecated. Use RoleUtils.hasRoleFromGroup(Stream, RoleModel, boolean) hasRoleFromGroup(Stream, RoleModel, boolean)} instead.
static boolean	RoleUtils.hasRoleFromGroup(Stream<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup)	Checks whether the targetRole is contained in any of the groups or their parents (if requested)
static boolean	RoleUtils.isMember(Set<GroupModel> groups, GroupModel targetGroup)	Deprecated. Use RoleUtils.isMember(Stream, GroupModel) isMember(Stream, GroupModel)} instead.
static boolean	RoleUtils.isMember(Stream<GroupModel> groups, GroupModel targetGroup)

Uses of GroupModel in org.keycloak.storage

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

Modifier and Type	Method	Description
default void	UserStorageProvider.preRemove(RealmModel realm, GroupModel group)	Callback when a group is removed.

Uses of GroupModel in org.keycloak.storage.adapter

Methods in org.keycloak.storage.adapter that return types with arguments of type GroupModel

Modifier and Type	Method	Description
Set<GroupModel>	AbstractUserAdapter.getGroups()
Set<GroupModel>	AbstractUserAdapter.Streams.getGroups()
Set<GroupModel>	AbstractUserAdapterFederatedStorage.getGroups()	Gets groups from federated storage and automatically appends default groups of realm.
Set<GroupModel>	AbstractUserAdapterFederatedStorage.Streams.getGroups()
protected Set<GroupModel>	AbstractUserAdapter.getGroupsInternal()	Get group membership mappings that are managed by this storage provider
protected Set<GroupModel>	AbstractUserAdapterFederatedStorage.getGroupsInternal()	Get group membership mappings that are managed by this storage provider
Stream<GroupModel>	AbstractUserAdapter.Streams.getGroupsStream()
Stream<GroupModel>	AbstractUserAdapterFederatedStorage.Streams.getGroupsStream()

Methods in org.keycloak.storage.adapter with parameters of type GroupModel

Modifier and Type	Method	Description
boolean	AbstractUserAdapter.isMemberOf(GroupModel group)
boolean	AbstractUserAdapter.Streams.isMemberOf(GroupModel group)
boolean	AbstractUserAdapterFederatedStorage.isMemberOf(GroupModel group)
boolean	AbstractUserAdapterFederatedStorage.Streams.isMemberOf(GroupModel group)
void	AbstractUserAdapter.joinGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.joinGroup(GroupModel group)
void	AbstractUserAdapter.leaveGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.leaveGroup(GroupModel group)

Uses of GroupModel in org.keycloak.storage.client

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

Modifier and Type	Method	Description
default void	ClientStorageProvider.preRemove(RealmModel realm, GroupModel group)	Callback when a group is removed.

Uses of GroupModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated that return types with arguments of type GroupModel

Modifier and Type	Method	Description
Set<GroupModel>	UserGroupMembershipFederatedStorage.getGroups(RealmModel realm, String userId)	Deprecated. Use getGroupsStream instead.
default Set<GroupModel>	UserGroupMembershipFederatedStorage.Streams.getGroups(RealmModel realm, String userId)
default Stream<GroupModel>	UserGroupMembershipFederatedStorage.getGroupsStream(RealmModel realm, String userId)	Obtains the groups associated with the federated user.
Stream<GroupModel>	UserGroupMembershipFederatedStorage.Streams.getGroupsStream(RealmModel realm, String userId)

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

Modifier and Type	Method	Description
List<String>	UserGroupMembershipFederatedStorage.getMembership(RealmModel realm, GroupModel group, int firstResult, int max)	Deprecated. Use getMembershipStream instead.
default List<String>	UserGroupMembershipFederatedStorage.Streams.getMembership(RealmModel realm, GroupModel group, int firstResult, int max)
default Stream<String>	UserGroupMembershipFederatedStorage.getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)	Obtains the federated users that are members of the given group in the specified realm.
Stream<String>	UserGroupMembershipFederatedStorage.Streams.getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
void	UserGroupMembershipFederatedStorage.joinGroup(RealmModel realm, String userId, GroupModel group)
void	UserGroupMembershipFederatedStorage.leaveGroup(RealmModel realm, String userId, GroupModel group)
void	UserFederatedStorageProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.storage.group

Methods in org.keycloak.storage.group that return GroupModel

Modifier and Type	Method	Description
GroupModel	GroupLookupProvider.getGroupById(RealmModel realm, String id)	Returns a group from the given realm with the corresponding id

Methods in org.keycloak.storage.group that return types with arguments of type GroupModel

Modifier and Type	Method	Description
default List<GroupModel>	GroupLookupProvider.searchForGroupByName(RealmModel realm, String search, Integer firstResult, Integer maxResults)	Deprecated. Use searchForGroupByNameStream instead.
Stream<GroupModel>	GroupLookupProvider.searchForGroupByNameStream(RealmModel realm, String search, Integer firstResult, Integer maxResults)	Returns the group hierarchy with the given string in name for the given realm.

Uses of GroupModel in org.keycloak.storage.user

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

Modifier and Type	Method	Description
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group)	Deprecated. Use getGroupMembersStream instead.
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)	Deprecated. Use getGroupMembersStream instead.
default List<UserModel>	UserQueryProvider.Streams.getGroupMembers(RealmModel realm, GroupModel group)
default List<UserModel>	UserQueryProvider.Streams.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group)	Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)