Package org.keycloak.admin.client.resource

Interface GroupsResource

public interface GroupsResource

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	add(GroupRepresentation rep)	create or add a top level realm groupSet or create child.
Map<String,Long>	count()	Counts all groups.
Map<String,Long>	count(boolean onlyTopGroups)	Counts groups by name search.
Map<String,Long>	count(String search)	Counts groups by name search.
GroupResource	group(String id)
List<GroupRepresentation>	groups()	Get all groups.
List<GroupRepresentation>	groups(Integer first, Integer max)	Get groups by pagination params.
List<GroupRepresentation>	groups(String search, Boolean exact, Integer first, Integer max, boolean briefRepresentation)	Get groups by pagination params.
List<GroupRepresentation>	groups(String search, Integer first, Integer max)	Get groups by pagination params.
List<GroupRepresentation>	groups(String search, Integer first, Integer max, boolean briefRepresentation)	Get groups by pagination params.
List<GroupRepresentation>	query(String searchQuery)
List<GroupRepresentation>	query(String searchQuery, boolean populateHierarchy)
List<GroupRepresentation>	query(String searchQuery, boolean populateHierarchy, Integer first, Integer max, boolean briefRepresentation)

Method Details

groups

@GET
@Produces("application/json")
List<GroupRepresentation> groups()

Get all groups.

Returns:

A list containing all groups.

groups

@GET
@Produces("application/json")
@Consumes("application/json")
List<GroupRepresentation> groups(@QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Get groups by pagination params.

Parameters:

first - index of the first element

max - max number of occurrences

Returns:

A list containing the slice of all groups.

groups

@GET
@Produces("application/json")
@Consumes("application/json")
List<GroupRepresentation> groups(@QueryParam("search")
 String search,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Get groups by pagination params.

Parameters:

search - max number of occurrences

first - index of the first element

max - max number of occurrences

Returns:

A list containing the slice of all groups.

groups

@GET
@Produces("application/json")
@Consumes("application/json")
List<GroupRepresentation> groups(@QueryParam("search")
 String search,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Get groups by pagination params.

Parameters:

search - max number of occurrences

first - index of the first element

max - max number of occurrences

briefRepresentation - if false, return groups with their attributes

Returns:

A list containing the slice of all groups.

groups

@GET
@Produces("application/json")
@Consumes("application/json")
List<GroupRepresentation> groups(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Get groups by pagination params.

Parameters:

search - search string for group

exact - exact match for search

first - index of the first element

max - max number of occurrences

briefRepresentation - if false, return groups with their attributes

Returns:

A list containing the slice of all groups.

count

@GET
@Path("count")
@Produces("application/json")
@Consumes("application/json")
Map<String,Long> count()

Counts all groups.

Returns:

A map containing key "count" with number of groups as value.

count

@GET
@Path("count")
@Produces("application/json")
@Consumes("application/json")
Map<String,Long> count(@QueryParam("search")
 String search)

Counts groups by name search.

Parameters:

search - max number of occurrences

Returns:

A map containing key "count" with number of groups as value which matching with search.

count

@GET
@Path("count")
@Produces("application/json")
@Consumes("application/json")
Map<String,Long> count(@QueryParam("top") @DefaultValue("true")
 boolean onlyTopGroups)

Counts groups by name search.

Parameters:

onlyTopGroups - true or false for filter only top level groups count

Returns:

A map containing key "count" with number of top level groups.

add

@POST
@Consumes("application/json")
jakarta.ws.rs.core.Response add(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 -

group

@Path("{id}")
GroupResource group(@PathParam("id")
 String id)

query

@GET
@Produces("application/json")
List<GroupRepresentation> query(@QueryParam("q")
 String searchQuery)

query

@GET
@Produces("application/json")
List<GroupRepresentation> query(@QueryParam("q")
 String searchQuery,
 @QueryParam("populateHierarchy")
 boolean populateHierarchy)

query

@GET
@Produces("application/json")
List<GroupRepresentation> query(@QueryParam("q")
 String searchQuery,
 @QueryParam("populateHierarchy")
 boolean populateHierarchy,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation")
 boolean briefRepresentation)