org.keycloak.admin.client.resource

Interface GroupResource

public interface GroupResource

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
List<UserRepresentation>	members(Integer firstResult, Integer maxResults) Get users Returns a list of users, filtered according to query parameters
void	remove()
RoleMappingResource	roles()
javax.ws.rs.core.Response	subGroup(GroupRepresentation rep) Set or create child.
GroupRepresentation	toRepresentation() Does not expand hierarchy.
void	update(GroupRepresentation rep) Update group

Method Detail

toRepresentation

@GET
 @Produces(value="application/json")
GroupRepresentation toRepresentation()

Does not expand hierarchy. Subgroups will not be set.

Returns:

update

@PUT
 @Consumes(value="application/json")
void update(GroupRepresentation rep)

Update group

Parameters:

rep -

remove

@DELETE
void remove()

subGroup

@POST
 @Path(value="children")
 @Produces(value="application/json")
 @Consumes(value="application/json")
javax.ws.rs.core.Response subGroup(GroupRepresentation rep)

Set or create child. This will just set the parent if it exists. Create it and set the parent if the group doesn't exist.

Parameters:

rep -

roles

@Path(value="role-mappings")
RoleMappingResource roles()

members

@GET
 @Path(value="/members")
 @Produces(value="application/json")
List<UserRepresentation> members(@QueryParam(value="first")
                                                                                                    Integer firstResult,
                                                                                                    @QueryParam(value="max")
                                                                                                    Integer maxResults)

Get users

Returns a list of users, filtered according to query parameters

Parameters:

firstResult - Pagination offset

maxResults - Pagination size

Returns: