Uses of Class
org.keycloak.representations.idm.GroupRepresentation

Packages that use GroupRepresentation

Package	Description
org.keycloak.admin.client.resource
org.keycloak.models.utils
org.keycloak.partialimport
org.keycloak.representations.idm
org.keycloak.services.resources.account
org.keycloak.services.resources.admin
org.keycloak.utils

Uses of GroupRepresentation in org.keycloak.admin.client.resource

Methods in org.keycloak.admin.client.resource that return GroupRepresentation

Modifier and Type	Method	Description
GroupRepresentation	RealmResource.getGroupByPath(String path)
GroupRepresentation	GroupResource.toRepresentation()	Does not expand hierarchy.

Methods in org.keycloak.admin.client.resource that return types with arguments of type GroupRepresentation

Modifier and Type	Method	Description
List<GroupRepresentation>	RealmResource.getDefaultGroups()
Set<GroupRepresentation>	RoleResource.getRoleGroupMembers()	Get role groups.
Set<GroupRepresentation>	RoleResource.getRoleGroupMembers(Integer firstResult, Integer maxResults)	Get role groups.
List<GroupRepresentation>	GroupResource.getSubGroups(Integer first, Integer max, Boolean briefRepresentation)	Get the paginated list of subgroups belonging to this group.
List<GroupRepresentation>	GroupResource.getSubGroups(Integer first, Integer max, Boolean briefRepresentation, Boolean subGroupsCount)	Get the paginated list of subgroups belonging to this group.
List<GroupRepresentation>	GroupResource.getSubGroups(String search, Boolean exact, Integer first, Integer max, Boolean briefRepresentation)	Get the paginated list of subgroups belonging to this group, filtered according to the specified parameters.
List<GroupRepresentation>	GroupResource.getSubGroups(String search, Boolean exact, Integer first, Integer max, Boolean briefRepresentation, Boolean subGroupsCount)	Get the paginated list of subgroups belonging to this group, filtered according to the specified parameters.
List<GroupRepresentation>	GroupsResource.groups()	Get all groups.
List<GroupRepresentation>	GroupsResource.groups(Integer first, Integer max)	Get groups by pagination params.
List<GroupRepresentation>	GroupsResource.groups(String search, Boolean exact, Integer first, Integer max, boolean briefRepresentation)	Get groups by pagination params.
List<GroupRepresentation>	GroupsResource.groups(String search, Boolean exact, Integer first, Integer max, boolean briefRepresentation, Boolean subGroupsCount)	Get groups by pagination params.
List<GroupRepresentation>	GroupsResource.groups(String search, Integer first, Integer max)	Get groups by pagination params.
List<GroupRepresentation>	GroupsResource.groups(String search, Integer first, Integer max, boolean briefRepresentation)	Get groups by pagination params.
List<GroupRepresentation>	UserResource.groups()
List<GroupRepresentation>	UserResource.groups(Integer firstResult, Integer maxResults)
List<GroupRepresentation>	UserResource.groups(Integer firstResult, Integer maxResults, boolean briefRepresentation)
List<GroupRepresentation>	UserResource.groups(String search, boolean briefRepresentation)
List<GroupRepresentation>	UserResource.groups(String search, Integer firstResult, Integer maxResults)
List<GroupRepresentation>	UserResource.groups(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)
List<GroupRepresentation>	GroupsResource.query(String searchQuery)
List<GroupRepresentation>	GroupsResource.query(String searchQuery, boolean populateHierarchy)
List<GroupRepresentation>	GroupsResource.query(String searchQuery, boolean populateHierarchy, Integer first, Integer max, boolean briefRepresentation)

Methods in org.keycloak.admin.client.resource with parameters of type GroupRepresentation

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	GroupsResource.add(GroupRepresentation rep)	create or add a top level realm groupSet or create child.
jakarta.ws.rs.core.Response	GroupResource.subGroup(GroupRepresentation rep)	Set or create child.
void	GroupResource.update(GroupRepresentation rep)	Update group

Uses of GroupRepresentation in org.keycloak.models.utils

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

Modifier and Type	Method	Description
static GroupRepresentation	ModelToRepresentation.groupToBriefRepresentation(GroupModel g)
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)

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

Modifier and Type	Method	Description
static Stream<GroupRepresentation>	ModelToRepresentation.toGroupHierarchy(KeycloakSession session, RealmModel realm, boolean full)	Deprecated.

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

Modifier and Type	Method	Description
static void	RepresentationToModel.importGroup(RealmModel realm, GroupModel parent, GroupRepresentation group)

Uses of GroupRepresentation in org.keycloak.partialimport

Methods in org.keycloak.partialimport that return types with arguments of type GroupRepresentation

Modifier and Type	Method	Description
List<GroupRepresentation>	GroupsPartialImport.getRepList(PartialImportRepresentation partialImportRep)

Methods in org.keycloak.partialimport with parameters of type GroupRepresentation

Modifier and Type	Method	Description
void	GroupsPartialImport.create(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)
boolean	GroupsPartialImport.exists(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)
String	GroupsPartialImport.existsMessage(RealmModel realm, GroupRepresentation groupRep)
String	GroupsPartialImport.getModelId(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)
String	GroupsPartialImport.getName(GroupRepresentation group)
void	GroupsPartialImport.remove(RealmModel realm, KeycloakSession session, GroupRepresentation groupRep)

Uses of GroupRepresentation in org.keycloak.representations.idm

Fields in org.keycloak.representations.idm with type parameters of type GroupRepresentation

Modifier and Type	Field	Description
protected List<GroupRepresentation>	PartialImportRepresentation.groups
protected List<GroupRepresentation>	RealmRepresentation.groups
protected List<GroupRepresentation>	GroupRepresentation.subGroups

Methods in org.keycloak.representations.idm that return GroupRepresentation

Modifier and Type	Method	Description
GroupRepresentation	GroupRepresentation.singleAttribute(String name, String value)

Methods in org.keycloak.representations.idm that return types with arguments of type GroupRepresentation

Modifier and Type	Method	Description
List<GroupRepresentation>	PartialImportRepresentation.getGroups()
List<GroupRepresentation>	RealmRepresentation.getGroups()
List<GroupRepresentation>	GroupRepresentation.getSubGroups()

Methods in org.keycloak.representations.idm with parameters of type GroupRepresentation

Modifier and Type	Method	Description
void	GroupRepresentation.merge(GroupRepresentation g)

Method parameters in org.keycloak.representations.idm with type arguments of type GroupRepresentation

Modifier and Type	Method	Description
void	PartialImportRepresentation.setGroups(List<GroupRepresentation> groups)
void	RealmRepresentation.setGroups(List<GroupRepresentation> groups)
void	GroupRepresentation.setSubGroups(List<GroupRepresentation> subGroups)

Uses of GroupRepresentation in org.keycloak.services.resources.account

Methods in org.keycloak.services.resources.account that return types with arguments of type GroupRepresentation

Modifier and Type	Method	Description
Stream<GroupRepresentation>	AccountRestService.groupMemberships(boolean briefRepresentation)

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

Methods in org.keycloak.services.resources.admin that return GroupRepresentation

Modifier and Type	Method	Description
GroupRepresentation	GroupResource.getGroup()
GroupRepresentation	RealmAdminResource.getGroupByPath(String path)

Methods in org.keycloak.services.resources.admin that return types with arguments of type GroupRepresentation

Modifier and Type	Method	Description
Stream<GroupRepresentation>	RealmAdminResource.getDefaultGroups()	Get group hierarchy.
Stream<GroupRepresentation>	GroupsResource.getGroups(String search, String searchQuery, Boolean exact, Integer firstResult, Integer maxResults, boolean briefRepresentation, boolean populateHierarchy, Boolean subGroupsCount)	Get group hierarchy.
Stream<GroupRepresentation>	RoleContainerResource.getGroupsInRole(String roleName, Integer firstResult, Integer maxResults, boolean briefRepresentation)	Returns a stream of groups that have the specified role name
Stream<GroupRepresentation>	GroupResource.getSubGroups(String search, Boolean exact, Integer first, Integer max, Boolean briefRepresentation, Boolean subGroupsCount)
Stream<GroupRepresentation>	UserResource.groupMembership(String search, Integer firstResult, Integer maxResults, boolean briefRepresentation)

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

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	GroupResource.addChild(GroupRepresentation rep)	Set or create child.
jakarta.ws.rs.core.Response	GroupsResource.addTopLevelGroup(GroupRepresentation rep)	create or add a top level realm groupSet or create child.
jakarta.ws.rs.core.Response	GroupResource.updateGroup(GroupRepresentation rep)	Update group, ignores subgroups.
static void	GroupResource.updateGroup(GroupRepresentation rep, GroupModel model, RealmModel realm, KeycloakSession session)

Uses of GroupRepresentation in org.keycloak.utils

Methods in org.keycloak.utils that return GroupRepresentation

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)

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

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.

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

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.