Uses of Interface
org.keycloak.models.GroupModel

Packages that use GroupModel

Package	Description
org.keycloak.federation.kerberos
org.keycloak.federation.sssd
org.keycloak.ipatuura_user_spi
org.keycloak.models
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.cache.infinispan.events
org.keycloak.models.jpa
org.keycloak.models.light
org.keycloak.models.utils
org.keycloak.organization.utils
org.keycloak.protocol.saml.mappers
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.fgap
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.group
org.keycloak.storage.jpa
org.keycloak.storage.ldap
org.keycloak.storage.ldap.mappers
org.keycloak.storage.ldap.mappers.membership.group
org.keycloak.storage.user
org.keycloak.utils

Uses of GroupModel in org.keycloak.federation.kerberos

Methods in org.keycloak.federation.kerberos with parameters of type GroupModel

Modifier and Type	Method	Description
void	KerberosFederationProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.federation.sssd

Methods in org.keycloak.federation.sssd with parameters of type GroupModel

Modifier and Type	Method	Description
void	SSSDFederationProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.ipatuura_user_spi

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

Modifier and Type	Method	Description
Stream<UserModel>	IpatuuraUserStorageProvider.getGroupMembersStream(RealmModel arg0, GroupModel arg1, Integer arg2, Integer arg3)

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, UserModel user, 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.cache.infinispan

Classes in org.keycloak.models.cache.infinispan that implement GroupModel

Modifier and Type	Class	Description
class	GroupAdapter

Fields in org.keycloak.models.cache.infinispan declared as GroupModel

Modifier and Type	Field	Description
protected GroupModel	GroupAdapter.updated

Methods in org.keycloak.models.cache.infinispan that return GroupModel

Modifier and Type	Method	Description
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
GroupModel	RealmCacheSession.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	RealmAdapter.getGroupById(String id)
GroupModel	RealmCacheSession.getGroupById(RealmModel realm, String id)
GroupModel	RealmCacheSession.getGroupByName(RealmModel realm, GroupModel parent, String name)
GroupModel	GroupAdapter.getParent()

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

Modifier and Type	Method	Description
Stream<GroupModel>	RealmAdapter.getDefaultGroupsStream()
Stream<GroupModel>	RealmCacheSession.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<GroupModel>	RealmAdapter.getGroupsStream()
Stream<GroupModel>	RealmCacheSession.getGroupsStream(RealmModel realm)
Stream<GroupModel>	RealmCacheSession.getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	UserAdapter.getGroupsStream()
Stream<GroupModel>	GroupAdapter.getSubGroupsStream()
Stream<GroupModel>	GroupAdapter.getSubGroupsStream(Integer firstResult, Integer maxResults)
Stream<GroupModel>	GroupAdapter.getSubGroupsStream(String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>	GroupAdapter.getSubGroupsStream(String search, Integer firstResult, Integer maxResults)
Stream<GroupModel>	RealmAdapter.getTopLevelGroupsStream()
Stream<GroupModel>	RealmAdapter.getTopLevelGroupsStream(Integer first, Integer max)
Stream<GroupModel>	RealmCacheSession.getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer first, Integer max)
Stream<GroupModel>	RealmCacheSession.searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>	RealmCacheSession.searchForGroupByNameStream(RealmModel realm, String search, Integer first, Integer max)
Stream<GroupModel>	RealmCacheSession.searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
void	GroupAdapter.addChild(GroupModel subGroup)
void	RealmAdapter.addDefaultGroup(GroupModel group)
void	RealmCacheSession.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
GroupModel	RealmCacheSession.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	RealmCacheSession.getGroupByName(RealmModel realm, GroupModel parent, String name)
Stream<UserModel>	UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	UserCacheSession.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults)
boolean	UserAdapter.isMemberOf(GroupModel group)
void	UserAdapter.joinGroup(GroupModel group)
void	UserAdapter.leaveGroup(GroupModel group)
void	RealmAdapter.moveGroup(GroupModel group, GroupModel toParent)
void	RealmCacheSession.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	UserCacheSession.preRemove(RealmModel realm, GroupModel group)
void	GroupAdapter.removeChild(GroupModel subGroup)
void	RealmAdapter.removeDefaultGroup(GroupModel group)
boolean	RealmAdapter.removeGroup(GroupModel group)
boolean	RealmCacheSession.removeGroup(RealmModel realm, GroupModel group)
void	GroupAdapter.setParent(GroupModel group)

Uses of GroupModel in org.keycloak.models.cache.infinispan.entities

Method parameters in org.keycloak.models.cache.infinispan.entities with type arguments of type GroupModel

Modifier and Type	Method	Description
MultivaluedHashMap<String,String>	CachedGroup.getAttributes(KeycloakSession session, Supplier<GroupModel> group)
Set<String>	CachedGroup.getRoleMappings(KeycloakSession session, Supplier<GroupModel> group)
Set<String>	CachedGroup.getSubGroups(KeycloakSession session, Supplier<GroupModel> group)

Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type GroupModel

Modifier	Constructor	Description
	CachedGroup(Long revision, RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.models.cache.infinispan.events

Methods in org.keycloak.models.cache.infinispan.events with parameters of type GroupModel

Modifier and Type	Method	Description
static GroupMovedEvent	GroupMovedEvent.create(GroupModel group, GroupModel toParent, String realmId)
static GroupRemovedEvent	GroupRemovedEvent.create(GroupModel group, String realmId)

Uses of GroupModel in org.keycloak.models.jpa

Classes in org.keycloak.models.jpa that implement GroupModel

Modifier and Type	Class	Description
class	GroupAdapter

Methods in org.keycloak.models.jpa that return GroupModel

Modifier and Type	Method	Description
GroupModel	JpaRealmProvider.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
GroupModel	JpaRealmProvider.getGroupById(RealmModel realm, String id)
GroupModel	RealmAdapter.getGroupById(String id)
GroupModel	JpaRealmProvider.getGroupByName(RealmModel realm, GroupModel parent, String name)
GroupModel	GroupAdapter.getParent()

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

Modifier and Type	Method	Description
Stream<GroupModel>	RealmAdapter.getDefaultGroupsStream()
Stream<GroupModel>	JpaRealmProvider.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<GroupModel>	JpaRealmProvider.getGroupsStream(RealmModel realm)
Stream<GroupModel>	JpaRealmProvider.getGroupsStream(RealmModel realm, Stream<String> ids)
Stream<GroupModel>	JpaRealmProvider.getGroupsStream(RealmModel realm, Stream<String> ids, Integer first, Integer max)
Stream<GroupModel>	JpaRealmProvider.getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	RealmAdapter.getGroupsStream()
Stream<GroupModel>	UserAdapter.getGroupsStream()
Stream<GroupModel>	UserAdapter.getGroupsStream(String search, Integer first, Integer max)
Stream<GroupModel>	GroupAdapter.getSubGroupsStream()
Stream<GroupModel>	GroupAdapter.getSubGroupsStream(String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>	JpaRealmProvider.getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>	RealmAdapter.getTopLevelGroupsStream()
Stream<GroupModel>	RealmAdapter.getTopLevelGroupsStream(Integer first, Integer max)
Stream<GroupModel>	JpaRealmProvider.searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer first, Integer max)
Stream<GroupModel>	JpaRealmProvider.searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
void	GroupAdapter.addChild(GroupModel subGroup)
void	RealmAdapter.addDefaultGroup(GroupModel group)
void	JpaRealmProvider.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel	JpaRealmProvider.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
GroupModel	JpaRealmProvider.getGroupByName(RealmModel realm, GroupModel parent, String name)
Stream<UserModel>	JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group)
Stream<UserModel>	JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
Stream<UserModel>	JpaUserProvider.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer first, Integer max)
protected jakarta.persistence.TypedQuery<UserGroupMembershipEntity>	UserAdapter.getUserGroupMappingQuery(GroupModel group)
boolean	UserAdapter.isMemberOf(GroupModel group)
void	UserAdapter.joinGroup(GroupModel group)
void	UserAdapter.joinGroup(GroupModel group, MembershipMetadata metadata)
protected void	UserAdapter.joinGroupImpl(GroupModel group)
protected void	UserAdapter.joinGroupImpl(GroupModel group, MembershipMetadata metadata)
void	UserAdapter.leaveGroup(GroupModel group)
void	JpaRealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	RealmAdapter.moveGroup(GroupModel group, GroupModel toParent)
void	JpaUserProvider.preRemove(RealmModel realm, GroupModel group)
void	GroupAdapter.removeChild(GroupModel subGroup)
void	RealmAdapter.removeDefaultGroup(GroupModel group)
boolean	JpaRealmProvider.removeGroup(RealmModel realm, GroupModel group)
boolean	RealmAdapter.removeGroup(GroupModel group)
void	GroupAdapter.setParent(GroupModel parent)
static GroupEntity	GroupAdapter.toEntity(GroupModel model, jakarta.persistence.EntityManager em)

Uses of GroupModel in org.keycloak.models.light

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

Modifier and Type	Method	Description
void	LightweightUserAdapter.joinGroup(GroupModel group)
void	LightweightUserAdapter.leaveGroup(GroupModel group)

Uses of GroupModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return GroupModel

Modifier and Type	Method	Description
GroupModel	RealmModelDelegate.createGroup(String name)
GroupModel	RealmModelDelegate.createGroup(String id, String name)
GroupModel	RealmModelDelegate.createGroup(String id, String name, GroupModel toParent)
GroupModel	RealmModelDelegate.createGroup(String name, GroupModel toParent)
static GroupModel	KeycloakModelUtils.findGroupByPath(KeycloakSession session, RealmModel realm, String path)	Finds group by path.
static GroupModel	KeycloakModelUtils.findGroupByPath(KeycloakSession session, RealmModel realm, String[] path)	Finds group by path.
GroupModel	RealmModelDelegate.getGroupById(String id)

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

Modifier and Type	Method	Description
Stream<GroupModel>	RealmModelDelegate.getDefaultGroupsStream()
Stream<GroupModel>	RealmModelDelegate.getGroupsStream()
Stream<GroupModel>	UserModelDelegate.getGroupsStream()
Stream<GroupModel>	RealmModelDelegate.getTopLevelGroupsStream()	Deprecated.
Stream<GroupModel>	RealmModelDelegate.getTopLevelGroupsStream(Integer first, Integer max)	Deprecated.

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

Modifier and Type	Method	Description
void	RealmModelDelegate.addDefaultGroup(GroupModel group)
static String	KeycloakModelUtils.buildGroupPath(GroupModel group)
static String	KeycloakModelUtils.buildGroupPath(GroupModel group, GroupModel otherParentGroup)
static String	ModelToRepresentation.buildGroupPath(GroupModel group)
GroupModel	RealmModelDelegate.createGroup(String id, String name, GroupModel toParent)
GroupModel	RealmModelDelegate.createGroup(String name, GroupModel toParent)
static GroupRepresentation	ModelToRepresentation.groupToBriefRepresentation(GroupModel g)
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 void	RepresentationToModel.importGroup(RealmModel realm, GroupModel parent, GroupRepresentation group)
static boolean	RoleUtils.isDirectMember(Stream<GroupModel> groups, GroupModel targetGroup)
static boolean	RoleUtils.isMember(Stream<GroupModel> groups, GroupModel targetGroup)
boolean	UserModelDelegate.isMemberOf(GroupModel group)
void	ReadOnlyUserModelDelegate.joinGroup(GroupModel group)
void	UserModelDelegate.joinGroup(GroupModel group)
void	ReadOnlyUserModelDelegate.leaveGroup(GroupModel group)
void	UserModelDelegate.leaveGroup(GroupModel group)
void	RealmModelDelegate.moveGroup(GroupModel group, GroupModel toParent)
void	RealmModelDelegate.removeDefaultGroup(GroupModel group)
boolean	RealmModelDelegate.removeGroup(GroupModel group)
static Collection<String>	KeycloakModelUtils.resolveAttribute(GroupModel group, String name, boolean aggregateAttrs)
static GroupRepresentation	ModelToRepresentation.toGroupHierarchy(GroupModel group, boolean full)	Deprecated.
static GroupRepresentation	ModelToRepresentation.toGroupHierarchy(GroupModel group, boolean full, String search)	Deprecated.
static GroupRepresentation	ModelToRepresentation.toGroupHierarchy(GroupModel group, boolean full, String search, Boolean exact)	Deprecated.
static GroupRepresentation	ModelToRepresentation.toRepresentation(GroupModel group, boolean full)

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.organization.utils

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

Modifier and Type	Method	Description
static Consumer<GroupModel>	Organizations.removeGroup(KeycloakSession session, RealmModel realm)

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

Modifier and Type	Method	Description
static boolean	Organizations.canManageOrganizationGroup(KeycloakSession session, GroupModel group)

Uses of GroupModel in org.keycloak.protocol.saml.mappers

Methods in org.keycloak.protocol.saml.mappers with parameters of type GroupModel

Modifier and Type	Method	Description
String	SAMLGroupNameMapper.mapName(ProtocolMapperModel model, GroupModel group)

Uses of GroupModel in org.keycloak.services.resources.admin

Methods in org.keycloak.services.resources.admin with parameters of type GroupModel

Modifier and Type	Method	Description
static void	GroupResource.updateGroup(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session)

Constructors in org.keycloak.services.resources.admin with parameters of type GroupModel

Modifier	Constructor	Description
	GroupResource(RealmModel realm, GroupModel group, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Uses of GroupModel in org.keycloak.services.resources.admin.fgap

Methods in org.keycloak.services.resources.admin.fgap with parameters of type GroupModel

Modifier and Type	Method	Description
boolean	GroupPermissionEvaluator.canManage(GroupModel group)	Returns true if the caller has AdminRoles.MANAGE_USERS role.
boolean	GroupPermissionEvaluator.canManageMembers(GroupModel group)	Returns true if the caller has AdminRoles.MANAGE_USERS role.
boolean	GroupPermissionEvaluator.canManageMembership(GroupModel group)	Returns true if the caller has AdminRoles.MANAGE_USERS role.
boolean	GroupPermissionEvaluator.canView(GroupModel group)	Returns true if the caller has one of AdminRoles.MANAGE_USERS or AdminRoles.VIEW_USERS roles.
boolean	GroupPermissionEvaluator.canViewMembers(GroupModel group)	Returns true if the caller has one of AdminRoles.MANAGE_USERS or AdminRoles.VIEW_USERS roles.
Map<String,Boolean>	GroupPermissionEvaluator.getAccess(GroupModel group)	Returns Map with information what access the caller for the provided group has.
Map<String,String>	GroupPermissionManagement.getPermissions(GroupModel group)
boolean	GroupPermissionManagement.isPermissionsEnabled(GroupModel group)
Policy	GroupPermissionManagement.manageMembershipPermission(GroupModel group)
Policy	GroupPermissionManagement.manageMembersPermission(GroupModel group)
Policy	GroupPermissionManagement.managePermission(GroupModel group)
void	GroupPermissionEvaluator.requireManage(GroupModel group)	Throws ForbiddenException if GroupPermissionEvaluator.canManage(GroupModel) returns false.
void	GroupPermissionEvaluator.requireManageMembers(GroupModel group)	Throws ForbiddenException if GroupPermissionEvaluator.canManageMembership(GroupModel) returns false.
void	GroupPermissionEvaluator.requireManageMembership(GroupModel group)	Throws ForbiddenException if GroupPermissionEvaluator.canManageMembership(GroupModel) returns false.
void	GroupPermissionEvaluator.requireView(GroupModel group)	Throws ForbiddenException if GroupPermissionEvaluator.canView(GroupModel) returns false.
void	GroupPermissionEvaluator.requireViewMembers(GroupModel group)	Throws ForbiddenException if GroupPermissionEvaluator.canViewMembers(GroupModel) returns false.
Resource	GroupPermissionManagement.resource(GroupModel group)
void	GroupPermissionManagement.setPermissionsEnabled(GroupModel group, boolean enable)
Policy	GroupPermissionManagement.viewMembersPermission(GroupModel group)
Policy	GroupPermissionManagement.viewPermission(GroupModel group)

Uses of GroupModel in org.keycloak.storage

Methods in org.keycloak.storage that return GroupModel

Modifier and Type	Method	Description
GroupModel	GroupStorageManager.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	GroupStorageManager.getGroupById(RealmModel realm, String id)
GroupModel	GroupStorageManager.getGroupByName(RealmModel realm, GroupModel parent, String name)

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

Modifier and Type	Method	Description
Stream<GroupModel>	GroupStorageManager.getGroupsByRoleStream(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults)
Stream<GroupModel>	GroupStorageManager.getGroupsStream(RealmModel realm)
Stream<GroupModel>	GroupStorageManager.getGroupsStream(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max)
Stream<GroupModel>	GroupStorageManager.getTopLevelGroupsStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)
Stream<GroupModel>	GroupStorageManager.searchForGroupByNameStream(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults)	Obtaining groups from an external client storage is time-bounded.
Stream<GroupModel>	GroupStorageManager.searchGroupsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
void	GroupStorageManager.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel	GroupStorageManager.createGroup(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent)
GroupModel	GroupStorageManager.getGroupByName(RealmModel realm, GroupModel parent, String name)
Stream<UserModel>	UserStorageManager.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)	UserLookupProvider methods implementations end here UserQueryProvider methods implementation start here
Stream<UserModel>	UserStorageManager.getGroupMembersStream(RealmModel realm, GroupModel group, String search, Boolean exact, Integer firstResult, Integer maxResults)
void	GroupStorageManager.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	UserStorageManager.preRemove(RealmModel realm, GroupModel group)
default void	UserStorageProvider.preRemove(RealmModel realm, GroupModel group)	Callback when a group is removed.
boolean	GroupStorageManager.removeGroup(RealmModel realm, GroupModel group)

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()	Deprecated. Use AbstractUserAdapter.getGroupsStream() instead
Set<GroupModel>	AbstractUserAdapter.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>	AbstractInMemoryUserAdapter.getGroupsStream()
Stream<GroupModel>	AbstractUserAdapter.getGroupsStream()
Stream<GroupModel>	AbstractUserAdapter.Streams.getGroupsStream()
Stream<GroupModel>	AbstractUserAdapterFederatedStorage.getGroupsStream()	Gets groups from federated storage and automatically appends default groups of realm.

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

Modifier and Type	Method	Description
boolean	AbstractInMemoryUserAdapter.isMemberOf(GroupModel group)
boolean	AbstractUserAdapter.isMemberOf(GroupModel group)
boolean	AbstractUserAdapter.Streams.isMemberOf(GroupModel group)
boolean	AbstractUserAdapterFederatedStorage.isMemberOf(GroupModel group)
void	AbstractInMemoryUserAdapter.joinGroup(GroupModel group)
void	AbstractUserAdapter.joinGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.joinGroup(GroupModel group)
void	UpdateOnlyChangeUserModelDelegate.joinGroup(GroupModel group)
void	AbstractInMemoryUserAdapter.leaveGroup(GroupModel group)
void	AbstractUserAdapter.leaveGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.leaveGroup(GroupModel group)
void	UpdateOnlyChangeUserModelDelegate.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
Stream<GroupModel>	UserGroupMembershipFederatedStorage.getGroupsStream(RealmModel realm, String userId)	Obtains the groups associated with the federated user.

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

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

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

Modifier and Type	Method	Description
Stream<GroupModel>	JpaUserFederatedStorageProvider.getGroupsStream(RealmModel realm, String userId)

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

Modifier and Type	Method	Description
Stream<String>	JpaUserFederatedStorageProvider.getMembershipStream(RealmModel realm, GroupModel group, Integer firstResult, Integer max)
void	JpaUserFederatedStorageProvider.joinGroup(RealmModel realm, String userId, GroupModel group)
void	JpaUserFederatedStorageProvider.leaveGroup(RealmModel realm, String userId, GroupModel group)
void	JpaUserFederatedStorageProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.storage.ldap

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

Modifier and Type	Method	Description
Stream<UserModel>	LDAPStorageProvider.getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults)
void	LDAPStorageProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.storage.ldap.mappers

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

Modifier and Type	Method	Description
List<UserModel>	AbstractLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
List<UserModel>	LDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)	Return empty list if doesn't support storing of groups

Uses of GroupModel in org.keycloak.storage.ldap.mappers.membership.group

Methods in org.keycloak.storage.ldap.mappers.membership.group that return GroupModel

Modifier and Type	Method	Description
protected GroupModel	GroupLDAPStorageMapper.createKcGroup(RealmModel realm, String ldapGroupName, GroupModel parentGroup)	Creates a new KC group from given LDAP group name in given KC parent group or the groups path.
protected GroupModel	GroupLDAPStorageMapper.findKcGroupByLDAPGroup(RealmModel realm, GroupModel parent, LDAPObject ldapGroup)
protected GroupModel	GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP(RealmModel realm, GroupModel parent, LDAPObject ldapGroup, UserModel user)
protected GroupModel	GroupLDAPStorageMapper.getKcGroupsPathGroup(RealmModel realm)	Provides KC group defined as groups path or null (top-level group) if corresponding group is not available.

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

Modifier and Type	Method	Description
protected Stream<GroupModel>	GroupLDAPStorageMapper.getAllKcGroups(RealmModel realm, GroupModel topParentGroup)	Provides a stream of all KC groups (with their sub groups) from groups path configured by the "Groups Path" configuration property.
Stream<GroupModel>	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.getGroupsStream()
protected Stream<GroupModel>	GroupLDAPStorageMapper.getKcSubGroups(RealmModel realm, GroupModel parentGroup)	Provides a list of all KC sub groups from given parent group or from groups path.
protected Stream<GroupModel>	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.getLDAPGroupMappingsConverted()

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

Modifier and Type	Method	Description
void	GroupLDAPStorageMapper.addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser)
protected GroupModel	GroupLDAPStorageMapper.createKcGroup(RealmModel realm, String ldapGroupName, GroupModel parentGroup)	Creates a new KC group from given LDAP group name in given KC parent group or the groups path.
protected GroupModel	GroupLDAPStorageMapper.findKcGroupByLDAPGroup(RealmModel realm, GroupModel parent, LDAPObject ldapGroup)
protected GroupModel	GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP(RealmModel realm, GroupModel parent, LDAPObject ldapGroup, UserModel user)
protected Stream<GroupModel>	GroupLDAPStorageMapper.getAllKcGroups(RealmModel realm, GroupModel topParentGroup)	Provides a stream of all KC groups (with their sub groups) from groups path configured by the "Groups Path" configuration property.
List<UserModel>	GroupLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults)
protected Stream<GroupModel>	GroupLDAPStorageMapper.getKcSubGroups(RealmModel realm, GroupModel parentGroup)	Provides a list of all KC sub groups from given parent group or from groups path.
protected boolean	GroupLDAPStorageMapper.isGroupInGroupPath(RealmModel realm, GroupModel group)
boolean	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.isMemberOf(GroupModel group)
void	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.joinGroup(GroupModel group)
void	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.leaveGroup(GroupModel group)

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.

Uses of GroupModel in org.keycloak.utils

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

Modifier and Type	Method	Description
static GroupRepresentation	GroupUtils.populateSubGroupCount(GroupModel group, GroupRepresentation representation)	This method's purpose is to look up the subgroup count of a Group and populate it on the representation.
static GroupRepresentation	GroupUtils.toRepresentation(GroupPermissionEvaluator groupsEvaluator, GroupModel groupTree, boolean full)

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

Modifier and Type	Method	Description
static Stream<GroupRepresentation>	GroupUtils.populateGroupHierarchyFromSubGroups(KeycloakSession session, RealmModel realm, Stream<GroupModel> groups, boolean full, GroupPermissionEvaluator groupEvaluator, boolean subGroupsCount)	This method takes the provided groups and attempts to load their parents all the way to the root group while maintaining the hierarchy data for each GroupRepresentation object.