Class GroupsResource

java.lang.Object
org.keycloak.services.resources.admin.GroupsResource

public class GroupsResource extends Object
Author:
Bill Burke
  • Constructor Details

  • Method Details

    • getGroups

      @GET @Produces("application/json") public Stream<GroupRepresentation> getGroups(@QueryParam("search") String search, @QueryParam("q") String searchQuery, @QueryParam("exact") @DefaultValue("false") Boolean exact, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults, @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation, @QueryParam("populateHierarchy") @DefaultValue("true") boolean populateHierarchy)
      Get group hierarchy. Only name and ids are returned.
      Returns:
    • getGroupById

      @Path("{group-id}") public GroupResource getGroupById(@PathParam("group-id") String id)
      Does not expand hierarchy. Subgroups will not be set.
      Parameters:
      id -
      Returns:
    • getGroupCount

      @GET @Path("count") @Produces("application/json") public Map<String,Long> getGroupCount(@QueryParam("search") String search, @QueryParam("top") @DefaultValue("false") boolean onlyTopGroups)
      Returns the groups counts.
      Returns:
    • addTopLevelGroup

      @POST @Consumes("application/json") public jakarta.ws.rs.core.Response addTopLevelGroup(GroupRepresentation rep)
      create or add a top level realm groupSet or create child. This will update the group and set the parent if it exists. Create it and set the parent if the group doesn't exist.
      Parameters:
      rep -