Uses of Interface
org.keycloak.models.GroupModel

Packages that use GroupModel

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

Uses of GroupModel in org.keycloak.models

Methods in org.keycloak.models that return GroupModel

Modifier and Type	Method and Description
GroupModel	RealmProvider.createGroup(RealmModel realm, String name)
GroupModel	RealmProvider.createGroup(RealmModel realm, String id, String name)
GroupModel	RealmModel.createGroup(String name)
GroupModel	RealmModel.createGroup(String id, String name)
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)
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.utils

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 boolean	RoleUtils.hasRoleFromGroup(GroupModel group, RoleModel targetRole, boolean checkParentGroup) Checks whether the targetRole is contained in the given group or its parents (if requested)
static boolean	RoleUtils.isMember(Set<GroupModel> groups, GroupModel targetGroup)
boolean	UserModelDelegate.isMemberOf(GroupModel group)
void	UserModelDelegate.joinGroup(GroupModel group)
void	UserModelDelegate.leaveGroup(GroupModel group)

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

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

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

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

Uses of GroupModel in org.keycloak.storage.adapter

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

Modifier and Type	Method and Description
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	AbstractUserAdapterFederatedStorage.isMemberOf(GroupModel group)
boolean	AbstractUserAdapter.isMemberOf(GroupModel group)
void	AbstractUserAdapterFederatedStorage.joinGroup(GroupModel group)
void	AbstractUserAdapter.joinGroup(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.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.