Package org.keycloak.organization.admin.resource

Class OrganizationGroupsResource

java.lang.Object

org.keycloak.organization.admin.resource.OrganizationGroupsResource

public class OrganizationGroupsResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OrganizationGroupsResource(KeycloakSession session, OrganizationModel organization, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addTopLevelGroup(GroupRepresentation rep)
OrganizationGroupResource	getGroupById(String id)
GroupRepresentation	getGroupByPath(String path, boolean subGroupsCount)
Stream<GroupRepresentation>	getGroups(String search, String searchQuery, Boolean exact, Integer first, Integer max, boolean briefRepresentation, boolean populateHierarchy, boolean subGroupsCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrganizationGroupsResource

public OrganizationGroupsResource(KeycloakSession session,
 OrganizationModel organization,
 AdminEventBuilder adminEvent)

Method Details

addTopLevelGroup

@POST
@Consumes("application/json")
public jakarta.ws.rs.core.Response addTopLevelGroup(GroupRepresentation rep)

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 first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation,
 @QueryParam("populateHierarchy") @DefaultValue("false")
 boolean populateHierarchy,
 @QueryParam("subGroupsCount") @DefaultValue("false")
 boolean subGroupsCount)

getGroupByPath

@GET
@Path("group-by-path/{path: .*}")
@Produces("application/json")
public GroupRepresentation getGroupByPath(@PathParam("path")
 String path,
 @QueryParam("subGroupsCount") @DefaultValue("false")
 boolean subGroupsCount)

getGroupById

@Path("{group-id}")
public OrganizationGroupResource getGroupById(@PathParam("group-id")
 String id)