Package org.keycloak.admin.ui.rest

Class GroupsResource

java.lang.Object

org.keycloak.admin.ui.rest.GroupsResource

public class GroupsResource
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupsResource(KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth)

Method Summary

Modifier and Type	Method	Description
Stream<org.keycloak.representations.idm.GroupRepresentation>	listGroups(String search, int first, int max, boolean global, boolean exact)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsResource

public GroupsResource(KeycloakSession session,
                      RealmModel realm,
                      AdminPermissionEvaluator auth)

Method Detail

listGroups

@GET
@Consumes("application/json")
@Produces("application/json")
public final Stream<org.keycloak.representations.idm.GroupRepresentation> listGroups(@QueryParam("search") @DefaultValue("")
                                                                                     String search,
                                                                                     @QueryParam("first") @DefaultValue("0")
                                                                                     int first,
                                                                                     @QueryParam("max") @DefaultValue("10")
                                                                                     int max,
                                                                                     @QueryParam("global") @DefaultValue("true")
                                                                                     boolean global,
                                                                                     @QueryParam("exact") @DefaultValue("false")
                                                                                     boolean exact)