org.keycloak.admin.client.resource

Interface GroupsResource

public interface GroupsResource

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

groups

List<GroupRepresentation> groups()

Get all groups.

Returns:

A list containing all groups.

groups

List<GroupRepresentation> groups(Integer first,
                                 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

List<GroupRepresentation> groups(String search,
                                 Integer first,
                                 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.

count

Map<String,Long> count()

Counts all groups.

Returns:

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

count

Map<String,Long> count(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

Map<String,Long> count(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

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

GroupResource group(String id)