public interface GroupsResource
Modifier and Type | Method and Description |
---|---|
javax.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,
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.
|
@GET @Produces(value="application/json") List<GroupRepresentation> groups()
@GET @Produces(value="application/json") @Consumes(value="application/json") List<GroupRepresentation> groups(@QueryParam(value="first") Integer first, @QueryParam(value="max") Integer max)
first
- index of the first elementmax
- max number of occurrences@GET @Produces(value="application/json") @Consumes(value="application/json") List<GroupRepresentation> groups(@QueryParam(value="search") String search, @QueryParam(value="first") Integer first, @QueryParam(value="max") Integer max)
search
- max number of occurrencesfirst
- index of the first elementmax
- max number of occurrences@GET @Produces(value="application/json") @Consumes(value="application/json") List<GroupRepresentation> groups(@QueryParam(value="search") String search, @QueryParam(value="first") Integer first, @QueryParam(value="max") Integer max, @QueryParam(value="briefRepresentation") @DefaultValue(value="true") boolean briefRepresentation)
search
- max number of occurrencesfirst
- index of the first elementmax
- max number of occurrencesbriefRepresentation
- if false, return groups with their attributes@GET @Path(value="count") @Produces(value="application/json") @Consumes(value="application/json") Map<String,Long> count()
@GET @Path(value="count") @Produces(value="application/json") @Consumes(value="application/json") Map<String,Long> count(@QueryParam(value="search") String search)
search
- max number of occurrences@GET @Path(value="count") @Produces(value="application/json") @Consumes(value="application/json") Map<String,Long> count(@QueryParam(value="top") @DefaultValue(value="true") boolean onlyTopGroups)
onlyTopGroups
- true
or false
for filter only top level groups count@POST @Consumes(value="application/json") javax.ws.rs.core.Response add(GroupRepresentation rep)
rep
- @Path(value="{id}") GroupResource group(@PathParam(value="id") String id)
Copyright © 2021 JBoss by Red Hat. All rights reserved.