Uses of Interface
org.keycloak.models.GroupModel

Packages that use GroupModel

Package	Description
org.keycloak.federation.kerberos
org.keycloak.federation.sssd
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.utils
org.keycloak.protocol.saml.mappers
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.permissions
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.jpa
org.keycloak.storage.ldap
org.keycloak.storage.ldap.mappers
org.keycloak.storage.ldap.mappers.membership.group
org.keycloak.storage.user

Uses of GroupModel in org.keycloak.federation.kerberos

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

Modifier and Type	Method and 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 and Description
void	SSSDFederationProvider.preRemove(RealmModel realm, GroupModel group)

Uses of GroupModel in org.keycloak.models

Methods in org.keycloak.models that return GroupModel

Modifier and Type	Method and Description
default GroupModel	RealmProvider.createGroup(RealmModel realm, String name)
default GroupModel	RealmProvider.createGroup(RealmModel realm, String name, GroupModel toParent)
default GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name)
GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String name)
default GroupModel	RealmModel.createGroup(String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String id, String name)
GroupModel	RealmModel.createGroup(String id, String name, GroupModel toParent)
GroupModel	GroupModel.GroupRemovedEvent.getGroup()
GroupModel	RealmModel.getGroupById(String id)
GroupModel	RealmProvider.getGroupById(String id, RealmModel realm)
GroupModel	GroupModel.getParent()

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

Modifier and Type	Method and Description
List<GroupModel>	RealmModel.getDefaultGroups()
Set<GroupModel>	UserModel.getGroups()
List<GroupModel>	RealmModel.getGroups()
default Set<GroupModel>	UserModel.getGroups(int first, int max)
List<GroupModel>	RealmProvider.getGroups(RealmModel realm)
default Set<GroupModel>	UserModel.getGroups(String search, int first, int max)
List<GroupModel>	RealmProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
Set<GroupModel>	GroupModel.getSubGroups()
List<GroupModel>	RealmModel.getTopLevelGroups()
List<GroupModel>	RealmModel.getTopLevelGroups(Integer first, Integer max)
List<GroupModel>	RealmProvider.getTopLevelGroups(RealmModel realm)
List<GroupModel>	RealmProvider.getTopLevelGroups(RealmModel realm, Integer first, Integer max)
List<GroupModel>	RealmModel.searchForGroupByName(String search, Integer first, Integer max)

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

Modifier and Type	Method and Description
void	GroupModel.addChild(GroupModel subGroup) Automatically calls setParent() on the subGroup
void	RealmModel.addDefaultGroup(GroupModel group)
void	RealmProvider.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
default GroupModel	RealmProvider.createGroup(RealmModel realm, String name, GroupModel toParent)
GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name, GroupModel toParent)
default GroupModel	RealmModel.createGroup(String name, GroupModel toParent)
GroupModel	RealmModel.createGroup(String id, String name, GroupModel toParent)
boolean	UserModel.isMemberOf(GroupModel group)
void	UserModel.joinGroup(GroupModel group)
void	UserModel.leaveGroup(GroupModel group)
void	RealmModel.moveGroup(GroupModel group, GroupModel toParent)
void	RealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	UserProvider.preRemove(RealmModel realm, GroupModel group)
void	GroupModel.removeChild(GroupModel subGroup) Automatically calls setParent() on the subGroup
void	RealmModel.removeDefaultGroup(GroupModel group)
boolean	RealmModel.removeGroup(GroupModel group)
boolean	RealmProvider.removeGroup(RealmModel realm, 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

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

Modifier and Type	Field and Description
protected GroupModel	GroupAdapter.updated

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

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

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

Modifier and Type	Method and Description
List<GroupModel>	RealmAdapter.getDefaultGroups()
Set<GroupModel>	UserAdapter.getGroups()
List<GroupModel>	RealmAdapter.getGroups()
List<GroupModel>	RealmCacheSession.getGroups(RealmModel realm)
List<GroupModel>	RealmCacheSession.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
Set<GroupModel>	GroupAdapter.getSubGroups()
List<GroupModel>	RealmAdapter.getTopLevelGroups()
List<GroupModel>	RealmAdapter.getTopLevelGroups(Integer first, Integer max)
List<GroupModel>	RealmCacheSession.getTopLevelGroups(RealmModel realm)
List<GroupModel>	RealmCacheSession.getTopLevelGroups(RealmModel realm, Integer first, Integer max)
List<GroupModel>	RealmCacheSession.searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
List<GroupModel>	RealmAdapter.searchForGroupByName(String search, Integer first, Integer max)

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

Modifier and Type	Method and Description
void	GroupAdapter.addChild(GroupModel subGroup)
void	RealmAdapter.addDefaultGroup(GroupModel group)
void	RealmCacheSession.addTopLevelGroup(RealmModel realm, GroupModel subGroup)
GroupModel	RealmCacheSession.createGroup(RealmModel realm, String id, String name, GroupModel toParent)
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
List<UserModel>	UserCacheSession.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	UserCacheSession.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int 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 and Description
MultivaluedHashMap<String,String>	CachedGroup.getAttributes(Supplier<GroupModel> group)
Set<String>	CachedGroup.getRoleMappings(Supplier<GroupModel> group)
Set<String>	CachedGroup.getSubGroups(Supplier<GroupModel> group)

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

Constructor and 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 and 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 and Description
class	GroupAdapter

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

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

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

Modifier and Type	Method and Description
List<GroupModel>	RealmAdapter.getDefaultGroups()
Set<GroupModel>	UserAdapter.getGroups()
List<GroupModel>	RealmAdapter.getGroups()
List<GroupModel>	JpaRealmProvider.getGroups(RealmModel realm)
Set<GroupModel>	UserAdapter.getGroups(String search, int first, int max)
List<GroupModel>	JpaRealmProvider.getGroupsByRole(RealmModel realm, RoleModel role, int firstResult, int maxResults)
Set<GroupModel>	GroupAdapter.getSubGroups()
List<GroupModel>	RealmAdapter.getTopLevelGroups()
List<GroupModel>	RealmAdapter.getTopLevelGroups(Integer first, Integer max)
List<GroupModel>	JpaRealmProvider.getTopLevelGroups(RealmModel realm)
List<GroupModel>	JpaRealmProvider.getTopLevelGroups(RealmModel realm, Integer first, Integer max)
List<GroupModel>	JpaRealmProvider.searchForGroupByName(RealmModel realm, String search, Integer first, Integer max)
List<GroupModel>	RealmAdapter.searchForGroupByName(String search, Integer first, Integer max)

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

Modifier and Type	Method and 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, String name, GroupModel toParent)
GroupModel	RealmAdapter.createGroup(String id, String name, GroupModel toParent)
List<UserModel>	JpaUserProvider.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	JpaUserProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
protected javax.persistence.TypedQuery<UserGroupMembershipEntity>	UserAdapter.getUserGroupMappingQuery(GroupModel group)
boolean	UserAdapter.isMemberOf(GroupModel group)
void	UserAdapter.joinGroup(GroupModel group)
protected void	UserAdapter.joinGroupImpl(GroupModel group)
void	UserAdapter.leaveGroup(GroupModel group)
void	RealmAdapter.moveGroup(GroupModel group, GroupModel toParent)
void	JpaRealmProvider.moveGroup(RealmModel realm, GroupModel group, GroupModel toParent)
void	JpaUserProvider.preRemove(RealmModel realm, GroupModel group)
void	GroupAdapter.removeChild(GroupModel subGroup)
void	RealmAdapter.removeDefaultGroup(GroupModel group)
boolean	RealmAdapter.removeGroup(GroupModel group)
boolean	JpaRealmProvider.removeGroup(RealmModel realm, GroupModel group)
void	GroupAdapter.setParent(GroupModel parent)
static GroupEntity	GroupAdapter.toEntity(GroupModel model, javax.persistence.EntityManager em)

Uses of GroupModel in org.keycloak.models.utils

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

Modifier and Type	Method and Description
static GroupModel	KeycloakModelUtils.findGroupByPath(RealmModel realm, String path)

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

Modifier and Type	Method and Description
Set<GroupModel>	UserModelDelegate.getGroups()

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

Modifier and Type	Method and Description
static String	ModelToRepresentation.buildGroupPath(GroupModel group)
static void	ModelToRepresentation.buildGroupPath(StringBuilder sb, GroupModel group)
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.isMember(Set<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)
static List<String>	KeycloakModelUtils.resolveAttribute(GroupModel group, String name)
static String	KeycloakModelUtils.resolveFirstAttribute(GroupModel group, String name)
static GroupRepresentation	ModelToRepresentation.toGroupHierarchy(GroupModel group, boolean full)
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 and Description
static boolean	RoleUtils.hasRoleFromGroup(Iterable<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)

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 and 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 and Description
static ManagementPermissionReference	GroupResource.toMgmtRef(GroupModel group, AdminPermissionManagement permissions)
static void	GroupResource.updateGroup(GroupRepresentation rep, GroupModel model)

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

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

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

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

Modifier and Type	Method and Description
boolean	GroupPermissionEvaluator.canManage(GroupModel group)
boolean	GroupPermissionEvaluator.canManageMembers(GroupModel group)
boolean	GroupPermissionEvaluator.canManageMembership(GroupModel group)
boolean	GroupPermissionEvaluator.canView(GroupModel group)
Map<String,Boolean>	GroupPermissionEvaluator.getAccess(GroupModel group)
boolean	GroupPermissionEvaluator.getGroupsWithViewPermission(GroupModel group)
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)
void	GroupPermissionEvaluator.requireManageMembership(GroupModel group)
void	GroupPermissionEvaluator.requireView(GroupModel group)
void	GroupPermissionEvaluator.requireViewMembers(GroupModel group)
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 with parameters of type GroupModel

Modifier and Type	Method and Description
List<UserModel>	UserStorageManager.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	UserStorageManager.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)
void	UserStorageManager.preRemove(RealmModel realm, GroupModel group)
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 and Description
Set<GroupModel>	InMemoryUserAdapter.getGroups()
Set<GroupModel>	AbstractUserAdapterFederatedStorage.getGroups() Gets groups from federated storage and automatically appends default groups of realm.
Set<GroupModel>	AbstractUserAdapter.getGroups()
protected Set<GroupModel>	AbstractUserAdapterFederatedStorage.getGroupsInternal() Get group membership mappings that are managed by this storage provider
protected Set<GroupModel>	AbstractUserAdapter.getGroupsInternal() Get group membership mappings that are managed by this storage provider

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

Modifier and Type	Method and Description
boolean	InMemoryUserAdapter.isMemberOf(GroupModel group)
boolean	AbstractUserAdapterFederatedStorage.isMemberOf(GroupModel group)
boolean	AbstractUserAdapter.isMemberOf(GroupModel group)
void	InMemoryUserAdapter.joinGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.joinGroup(GroupModel group)
void	AbstractUserAdapter.joinGroup(GroupModel group)
void	InMemoryUserAdapter.leaveGroup(GroupModel group)
void	AbstractUserAdapterFederatedStorage.leaveGroup(GroupModel group)
void	AbstractUserAdapter.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 and 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 and Description
Set<GroupModel>	UserGroupMembershipFederatedStorage.getGroups(RealmModel realm, String userId)

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

Modifier and Type	Method and Description
List<String>	UserGroupMembershipFederatedStorage.getMembership(RealmModel realm, GroupModel group, int firstResult, int 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.jpa

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

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

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

Modifier and Type	Method and Description
List<String>	JpaUserFederatedStorageProvider.getMembership(RealmModel realm, GroupModel group, int firstResult, int 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 and Description
List<UserModel>	LDAPStorageProvider.getGroupMembers(RealmModel realm, GroupModel group)
List<UserModel>	LDAPStorageProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int 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 and Description
List<UserModel>	LDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Return empty list if doesn't support storing of groups
List<UserModel>	AbstractLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults)

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 and Description
protected GroupModel	GroupLDAPStorageMapper.findKcGroupByLDAPGroup(RealmModel realm, LDAPObject ldapGroup)
protected GroupModel	GroupLDAPStorageMapper.findKcGroupOrSyncFromLDAP(RealmModel realm, LDAPObject ldapGroup, UserModel user)

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

Modifier and Type	Method and Description
Set<GroupModel>	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.getGroups()
protected Set<GroupModel>	GroupLDAPStorageMapper.LDAPGroupMappingsUserDelegate.getLDAPGroupMappingsConverted()

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

Modifier and Type	Method and Description
void	GroupLDAPStorageMapper.addGroupMappingInLDAP(RealmModel realm, GroupModel kcGroup, LDAPObject ldapUser)
List<UserModel>	GroupLDAPStorageMapper.getGroupMembers(RealmModel realm, GroupModel kcGroup, int firstResult, int maxResults)
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 and Description
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group) Get users that belong to a specific group.
List<UserModel>	UserQueryProvider.getGroupMembers(RealmModel realm, GroupModel group, int firstResult, int maxResults) Get users that belong to a specific group.