Package org.keycloak.admin.client.resource

Interface OrganizationGroupsResource

public interface OrganizationGroupsResource

Since:

Keycloak server 26.6.0. All the child endpoints are also available since that version unless mentioned otherwise

Organization groups resource for managing groups within an organization.

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addTopLevelGroup(org.keycloak.representations.idm.GroupRepresentation rep)
List<org.keycloak.representations.idm.GroupRepresentation>	getAll(String search, String searchQuery, Boolean exact, Integer first, Integer max, boolean briefRepresentation, boolean subGroupsCount)
List<org.keycloak.representations.idm.GroupRepresentation>	getAll(String search, String searchQuery, Boolean exact, Integer first, Integer max, boolean briefRepresentation, boolean populateHierarchy, boolean subGroupsCount)
org.keycloak.representations.idm.GroupRepresentation	getGroupByPath(String path, boolean subGroupsCount)
OrganizationGroupResource	group(String groupId)

Method Details

addTopLevelGroup

@POST
@Consumes("application/json")
jakarta.ws.rs.core.Response addTopLevelGroup(org.keycloak.representations.idm.GroupRepresentation rep)

getAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.GroupRepresentation> getAll(@QueryParam("search")
 String search,
 @QueryParam("q")
 String searchQuery,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation")
 boolean briefRepresentation,
 @QueryParam("subGroupsCount")
 boolean subGroupsCount)

getAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.GroupRepresentation> getAll(@QueryParam("search")
 String search,
 @QueryParam("q")
 String searchQuery,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation")
 boolean briefRepresentation,
 @QueryParam("populateHierarchy")
 boolean populateHierarchy,
 @QueryParam("subGroupsCount")
 boolean subGroupsCount)

getGroupByPath

@GET
@Path("group-by-path/{path: .*}")
@Produces("application/json")
org.keycloak.representations.idm.GroupRepresentation getGroupByPath(@PathParam("path")
 String path,
 @QueryParam("subGroupsCount")
 boolean subGroupsCount)

group

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