Uses of Interface
org.keycloak.models.GroupModel
Package
Description
-
Uses of GroupModel in org.keycloak.federation.kerberos
Modifier and TypeMethodDescriptionvoid
KerberosFederationProvider.preRemove
(RealmModel realm, GroupModel group) -
Uses of GroupModel in org.keycloak.federation.sssd
Modifier and TypeMethodDescriptionvoid
SSSDFederationProvider.preRemove
(RealmModel realm, GroupModel group) -
Uses of GroupModel in org.keycloak.models
Modifier and TypeMethodDescriptiondefault 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.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) RealmModel.createGroup
(String id, String name, GroupModel toParent) default GroupModel
RealmModel.createGroup
(String name, GroupModel toParent) GroupModel.GroupEvent.getGroup()
RealmModel.getGroupById
(String id) GroupModel.getParent()
Modifier and TypeMethodDescriptionRealmModel.getDefaultGroupsStream()
Returns default groups as a stream.GroupProvider.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) Returns groups with the given role in the given realm.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.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.RealmModel.getGroupsStream()
Returns groups as a stream.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 nameGroupModel.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.GroupProvider.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Returns top level groups (i.e.RealmModel.getTopLevelGroupsStream()
Deprecated.RealmModel.getTopLevelGroupsStream
(Integer first, Integer max) Deprecated.Modifier and TypeMethodDescriptionvoid
GroupModel.addChild
(GroupModel subGroup) Automatically calls setParent() on the subGroupvoid
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.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.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 subGroupvoid
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
Modifier and TypeMethodDescriptionRealmAdapter.createGroup
(String id, String name, GroupModel toParent) RealmCacheSession.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) RealmAdapter.getGroupById
(String id) RealmCacheSession.getGroupById
(RealmModel realm, String id) RealmCacheSession.getGroupByName
(RealmModel realm, GroupModel parent, String name) GroupAdapter.getParent()
Modifier and TypeMethodDescriptionRealmAdapter.getDefaultGroupsStream()
RealmCacheSession.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) RealmAdapter.getGroupsStream()
RealmCacheSession.getGroupsStream
(RealmModel realm) RealmCacheSession.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) UserAdapter.getGroupsStream()
GroupAdapter.getSubGroupsStream()
GroupAdapter.getSubGroupsStream
(Integer firstResult, Integer maxResults) GroupAdapter.getSubGroupsStream
(String search, Boolean exact, Integer firstResult, Integer maxResults) GroupAdapter.getSubGroupsStream
(String search, Integer firstResult, Integer maxResults) RealmAdapter.getTopLevelGroupsStream()
RealmAdapter.getTopLevelGroupsStream
(Integer first, Integer max) RealmCacheSession.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer first, Integer max) RealmCacheSession.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) RealmCacheSession.searchForGroupByNameStream
(RealmModel realm, String search, Integer first, Integer max) RealmCacheSession.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Modifier and TypeMethodDescriptionvoid
GroupAdapter.addChild
(GroupModel subGroup) void
RealmAdapter.addDefaultGroup
(GroupModel group) void
RealmCacheSession.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) RealmAdapter.createGroup
(String id, String name, GroupModel toParent) RealmCacheSession.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) RealmCacheSession.getGroupByName
(RealmModel realm, GroupModel parent, String name) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group) UserCacheSession.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) 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
Modifier and TypeMethodDescriptionCachedGroup.getAttributes
(Supplier<GroupModel> group) CachedGroup.getRoleMappings
(Supplier<GroupModel> group) CachedGroup.getSubGroups
(Supplier<GroupModel> group) CachedGroup.getSubGroupsCount
(Supplier<GroupModel> group) -
Uses of GroupModel in org.keycloak.models.cache.infinispan.events
Modifier and TypeMethodDescriptionstatic 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
Modifier and TypeMethodDescriptionJpaRealmProvider.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) RealmAdapter.createGroup
(String id, String name, GroupModel toParent) JpaRealmProvider.getGroupById
(RealmModel realm, String id) RealmAdapter.getGroupById
(String id) JpaRealmProvider.getGroupByName
(RealmModel realm, GroupModel parent, String name) GroupAdapter.getParent()
Modifier and TypeMethodDescriptionRealmAdapter.getDefaultGroupsStream()
JpaRealmProvider.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) JpaRealmProvider.getGroupsStream
(RealmModel realm) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, Integer first, Integer max) JpaRealmProvider.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) RealmAdapter.getGroupsStream()
UserAdapter.getGroupsStream()
UserAdapter.getGroupsStream
(String search, Integer first, Integer max) GroupAdapter.getSubGroupsStream()
GroupAdapter.getSubGroupsStream
(String search, Boolean exact, Integer firstResult, Integer maxResults) JpaRealmProvider.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) RealmAdapter.getTopLevelGroupsStream()
RealmAdapter.getTopLevelGroupsStream
(Integer first, Integer max) JpaRealmProvider.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer first, Integer max) JpaRealmProvider.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Modifier and TypeMethodDescriptionvoid
GroupAdapter.addChild
(GroupModel subGroup) void
RealmAdapter.addDefaultGroup
(GroupModel group) void
JpaRealmProvider.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) JpaRealmProvider.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) RealmAdapter.createGroup
(String id, String name, GroupModel toParent) JpaRealmProvider.getGroupByName
(RealmModel realm, GroupModel parent, String name) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group) JpaUserProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) 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
Modifier and TypeMethodDescriptionvoid
LightweightUserAdapter.joinGroup
(GroupModel group) void
LightweightUserAdapter.leaveGroup
(GroupModel group) -
Uses of GroupModel in org.keycloak.models.utils
Modifier and TypeMethodDescriptionRealmModelDelegate.createGroup
(String name) RealmModelDelegate.createGroup
(String id, String name) RealmModelDelegate.createGroup
(String id, String name, GroupModel toParent) 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.RealmModelDelegate.getGroupById
(String id) Modifier and TypeMethodDescriptionRealmModelDelegate.getDefaultGroupsStream()
RealmModelDelegate.getGroupsStream()
UserModelDelegate.getGroupsStream()
RealmModelDelegate.getTopLevelGroupsStream()
Deprecated.RealmModelDelegate.getTopLevelGroupsStream
(Integer first, Integer max) Deprecated.static Stream<GroupModel>
ModelToRepresentation.searchGroupModelsByAttributes
(KeycloakSession session, RealmModel realm, Map<String, String> attributes, Integer first, Integer max) Modifier and TypeMethodDescriptionvoid
RealmModelDelegate.addDefaultGroup
(GroupModel group) static String
KeycloakModelUtils.buildGroupPath
(GroupModel group) static String
KeycloakModelUtils.buildGroupPath
(GroupModel group, GroupModel otherParentGroup) static String
ModelToRepresentation.buildGroupPath
(GroupModel group) RealmModelDelegate.createGroup
(String id, String name, GroupModel toParent) RealmModelDelegate.createGroup
(String name, GroupModel toParent) static GroupRepresentation
ModelToRepresentation.groupToBriefRepresentation
(GroupModel g) static boolean
RoleUtils.hasRoleFromGroup
(GroupModel group, RoleModel targetRole, boolean checkParentGroup) Checks whether thetargetRole
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) Modifier and TypeMethodDescriptionstatic boolean
RoleUtils.hasRoleFromGroup
(Stream<GroupModel> groups, RoleModel targetRole, boolean checkParentGroup) Checks whether thetargetRole
is contained in any of thegroups
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
Modifier and TypeMethodDescriptionstatic Consumer<GroupModel>
Organizations.removeGroup
(KeycloakSession session, RealmModel realm) Modifier and TypeMethodDescriptionstatic boolean
Organizations.canManageOrganizationGroup
(KeycloakSession session, GroupModel group) -
Uses of GroupModel in org.keycloak.protocol.saml.mappers
Modifier and TypeMethodDescriptionSAMLGroupNameMapper.mapName
(ProtocolMapperModel model, GroupModel group) -
Uses of GroupModel in org.keycloak.services.resources.admin
Modifier and TypeMethodDescriptionGroupResource.toMgmtRef
(GroupModel group, AdminPermissionManagement permissions) static void
GroupResource.updateGroup
(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session) ModifierConstructorDescriptionGroupResource
(RealmModel realm, GroupModel group, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Uses of GroupModel in org.keycloak.services.resources.admin.permissions
Modifier and TypeMethodDescriptionboolean
GroupPermissionEvaluator.canManage
(GroupModel group) boolean
GroupPermissionEvaluator.canManageMembers
(GroupModel group) boolean
GroupPermissionEvaluator.canManageMembership
(GroupModel group) boolean
GroupPermissionEvaluator.canView
(GroupModel group) boolean
GroupPermissionEvaluator.canViewMembers
(GroupModel group) GroupPermissionEvaluator.getAccess
(GroupModel group) boolean
GroupPermissionEvaluator.getGroupsWithViewPermission
(GroupModel group) GroupPermissionManagement.getPermissions
(GroupModel group) boolean
GroupPermissionManagement.isPermissionsEnabled
(GroupModel group) GroupPermissionManagement.manageMembershipPermission
(GroupModel group) GroupPermissionManagement.manageMembersPermission
(GroupModel group) GroupPermissionManagement.managePermission
(GroupModel group) void
GroupPermissionEvaluator.requireManage
(GroupModel group) void
GroupPermissionEvaluator.requireManageMembers
(GroupModel group) void
GroupPermissionEvaluator.requireManageMembership
(GroupModel group) void
GroupPermissionEvaluator.requireView
(GroupModel group) void
GroupPermissionEvaluator.requireViewMembers
(GroupModel group) GroupPermissionManagement.resource
(GroupModel group) void
GroupPermissionManagement.setPermissionsEnabled
(GroupModel group, boolean enable) GroupPermissionManagement.viewMembersPermission
(GroupModel group) GroupPermissionManagement.viewPermission
(GroupModel group) -
Uses of GroupModel in org.keycloak.storage
Modifier and TypeMethodDescriptionGroupStorageManager.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) GroupStorageManager.getGroupById
(RealmModel realm, String id) GroupStorageManager.getGroupByName
(RealmModel realm, GroupModel parent, String name) Modifier and TypeMethodDescriptionGroupStorageManager.getGroupsByRoleStream
(RealmModel realm, RoleModel role, Integer firstResult, Integer maxResults) GroupStorageManager.getGroupsStream
(RealmModel realm) GroupStorageManager.getGroupsStream
(RealmModel realm, Stream<String> ids, String search, Integer first, Integer max) GroupStorageManager.getTopLevelGroupsStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) GroupStorageManager.searchForGroupByNameStream
(RealmModel realm, String search, Boolean exact, Integer firstResult, Integer maxResults) Obtaining groups from an external client storage is time-bounded.GroupStorageManager.searchGroupsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) Modifier and TypeMethodDescriptionvoid
GroupStorageManager.addTopLevelGroup
(RealmModel realm, GroupModel subGroup) GroupStorageManager.createGroup
(RealmModel realm, String id, GroupModel.Type type, String name, GroupModel toParent) GroupStorageManager.getGroupByName
(RealmModel realm, GroupModel parent, String name) UserStorageManager.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) UserLookupProvider
methods implementations end hereUserQueryProvider
methods implementation start hereUserStorageManager.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
Modifier and TypeMethodDescriptionAbstractUserAdapter.getGroups()
Deprecated.AbstractUserAdapter.Streams.getGroups()
protected Set<GroupModel>
AbstractUserAdapter.getGroupsInternal()
Get group membership mappings that are managed by this storage providerprotected Set<GroupModel>
AbstractUserAdapterFederatedStorage.getGroupsInternal()
Get group membership mappings that are managed by this storage providerAbstractInMemoryUserAdapter.getGroupsStream()
AbstractUserAdapter.getGroupsStream()
AbstractUserAdapter.Streams.getGroupsStream()
AbstractUserAdapterFederatedStorage.getGroupsStream()
Gets groups from federated storage and automatically appends default groups of realm.Modifier and TypeMethodDescriptionboolean
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
Modifier and TypeMethodDescriptiondefault void
ClientStorageProvider.preRemove
(RealmModel realm, GroupModel group) Callback when a group is removed. -
Uses of GroupModel in org.keycloak.storage.federated
Modifier and TypeMethodDescriptionUserGroupMembershipFederatedStorage.getGroupsStream
(RealmModel realm, String userId) Obtains the groups associated with the federated user.Modifier and TypeMethodDescriptionUserGroupMembershipFederatedStorage.getMembershipStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer max) Obtains the federated users that are members of the givengroup
in the specifiedrealm
.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
Modifier and TypeMethodDescriptionGroupLookupProvider.getGroupById
(RealmModel realm, String id) Returns a group from the given realm with the corresponding iddefault GroupModel
GroupLookupProvider.getGroupByName
(RealmModel realm, GroupModel parent, String name) Returns a group from the given realm with the corresponding name and parentModifier and TypeMethodDescriptionGroupLookupProvider.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.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.Modifier and TypeMethodDescriptiondefault 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
Modifier and TypeMethodDescriptionJpaUserFederatedStorageProvider.getGroupsStream
(RealmModel realm, String userId) Modifier and TypeMethodDescriptionJpaUserFederatedStorageProvider.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
Modifier and TypeMethodDescriptionLDAPStorageProvider.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
Modifier and TypeMethodDescriptionAbstractLDAPStorageMapper.getGroupMembers
(RealmModel realm, GroupModel group, int firstResult, int maxResults) 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
Modifier and TypeMethodDescriptionprotected 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.Modifier and TypeMethodDescriptionprotected 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.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()
Modifier and TypeMethodDescriptionvoid
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.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.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
Modifier and TypeMethodDescriptionUserQueryMethodsProvider.getGroupMembersStream
(RealmModel realm, GroupModel group) Obtains users that belong to a specific group.UserQueryMethodsProvider.getGroupMembersStream
(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) Obtains users that belong to a specific group.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
Modifier and TypeMethodDescriptionstatic 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) Modifier and TypeMethodDescriptionstatic Stream<GroupRepresentation>
GroupUtils.populateGroupHierarchyFromSubGroups
(KeycloakSession session, RealmModel realm, Stream<GroupModel> groups, boolean full, GroupPermissionEvaluator groupEvaluator) 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.
AbstractUserAdapter.getGroupsStream()
instead