Uses of Interface
org.keycloak.models.GroupModel

Packages that use GroupModel

Package	Description
org.keycloak.models
org.keycloak.models.utils
org.keycloak.storage.group
org.keycloak.storage.user

Uses of GroupModel in org.keycloak.models

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

Modifier and Type	Field	Description
static final Comparator<GroupModel>	GroupModel.COMPARE_BY_NAME

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.
default 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	GroupProvider.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)	Creates a new group with the given name, id, 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)
GroupModel	GroupModel.GroupEvent.getGroup()
GroupModel	RealmModel.getGroupById(String id)
GroupModel	GroupModel.getParent()

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

Modifier and Type	Method	Description
Stream<GroupModel>	RealmModel.getDefaultGroupsStream()	Returns default groups as a stream.
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.
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>	GroupModel.getSubGroupsStream()	Returns all sub groups for the parent group as a stream.
default Stream<GroupModel>	GroupModel.getSubGroupsStream(Integer firstResult, Integer maxResults)	Returns all sub groups for the parent group as a stream, paginated.
default Stream<GroupModel>	GroupModel.getSubGroupsStream(String search, Boolean exact, Integer firstResult, Integer maxResults)	Returns all subgroups for the parent group matching the search as a stream, paginated.
default Stream<GroupModel>	GroupModel.getSubGroupsStream(String search, Integer firstResult, Integer maxResults)	Returns all sub groups for the parent group matching the fuzzy search as a stream, paginated.
default Stream<GroupModel>	GroupProvider.getTopLevelGroupsStream(RealmModel realm)	Returns all top level groups (i.e.
default Stream<GroupModel>	GroupProvider.getTopLevelGroupsStream(RealmModel realm, Integer firstResult, Integer maxResults)	Returns top level groups (i.e.
Stream<GroupModel>	GroupProvider.getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)	Returns top level groups (i.e.
Stream<GroupModel>	RealmModel.getTopLevelGroupsStream()	Deprecated.
Stream<GroupModel>	RealmModel.getTopLevelGroupsStream(Integer first, Integer max)	Deprecated.

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.
default 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	GroupProvider.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)	Creates a new group with the given name, id, name and parent to the given realm.
GroupModel	RealmModel.createGroup(String id, String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String name, GroupModel toParent)
static void	GroupModel.GroupCreatedEvent.fire(GroupModel group, KeycloakSession session)
static void	GroupModel.GroupMemberJoinEvent.fire(GroupModel group, KeycloakSession session)
static void	GroupModel.GroupMemberLeaveEvent.fire(GroupModel group, KeycloakSession session)
static void	GroupModel.GroupPathChangeEvent.fire(GroupModel group, String newPath, String previousPath, KeycloakSession session)
static void	GroupModel.GroupUpdatedEvent.fire(GroupModel group, KeycloakSession session)
boolean	UserModel.isMemberOf(GroupModel group)
void	UserModel.joinGroup(GroupModel group)
default void	UserModel.joinGroup(GroupModel group, MembershipMetadata metadata)
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	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)
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.isDirectMember(Stream<GroupModel> groups, GroupModel targetGroup)
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(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.isDirectMember(Stream<GroupModel> groups, GroupModel targetGroup)
static boolean	RoleUtils.isMember(Stream<GroupModel> groups, GroupModel targetGroup)

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
default GroupModel	GroupLookupProvider.getGroupByName(RealmModel realm, GroupModel parent, String name)	Returns a group from the given realm with the corresponding name and parent

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

Modifier and Type	Method	Description
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.

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

Modifier and Type	Method	Description
default GroupModel	GroupLookupProvider.getGroupByName(RealmModel realm, GroupModel parent, String name)	Returns a group from the given realm with the corresponding name and parent

Uses of GroupModel in org.keycloak.storage.user

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

Modifier and Type	Method	Description
default Stream<UserModel>	UserQueryMethodsProvider.getGroupMembersStream(RealmModel realm, GroupModel group)	Obtains users that belong to a specific group.
Stream<UserModel>	UserQueryMethodsProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	Obtains users that belong to a specific group.
default Stream<UserModel>	UserQueryMethodsProvider.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max)	Obtains users that belong to a specific group, filtered according to the search parameters.