Interface GroupResource
-
public interface GroupResource
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagementPermissionReference
getPermissions()
Returns indicator if the fine grain permissions are enabled or not.List<UserRepresentation>
members()
Get usersList<UserRepresentation>
members(Integer firstResult, Integer maxResults)
Get usersList<UserRepresentation>
members(Integer firstResult, Integer maxResults, Boolean briefRepresentation)
Get usersvoid
remove()
RoleMappingResource
roles()
ManagementPermissionReference
setPermissions(ManagementPermissionRepresentation status)
Enables or disables the fine grain permissions feature.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
-
setPermissions
@PUT @Path("/management/permissions") @Consumes("application/json") @Produces("application/json") ManagementPermissionReference setPermissions(ManagementPermissionRepresentation status)
Enables or disables the fine grain permissions feature. Returns the updated status of the server in theManagementPermissionReference
.- Parameters:
status
- status request to apply- Returns:
- permission reference indicating the updated status
-
getPermissions
@GET @Path("/management/permissions") @Produces("application/json") ManagementPermissionReference getPermissions()
Returns indicator if the fine grain permissions are enabled or not.- Returns:
- current representation of the permissions feature
-
toRepresentation
@GET @Produces("application/json") GroupRepresentation toRepresentation()
Does not expand hierarchy. Subgroups will not be set.- Returns:
-
update
@PUT @Consumes("application/json") void update(GroupRepresentation rep)
Update group- Parameters:
rep
-
-
remove
@DELETE void remove()
-
subGroup
@POST @Path("children") @Produces("application/json") @Consumes("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("role-mappings") RoleMappingResource roles()
-
members
@GET @Path("/members") @Produces("application/json") List<UserRepresentation> members()
Get users Returns a list of all users in group.- Returns:
- Returns a max size of 100 users
-
members
@GET @Path("/members") @Produces("application/json") List<UserRepresentation> members(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)
Get users Returns a list of users, filtered according to query parameters- Parameters:
firstResult
- Pagination offsetmaxResults
- Pagination size- Returns:
-
members
@GET @Path("/members") @Produces("application/json") List<UserRepresentation> members(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults, @QueryParam("briefRepresentation") Boolean briefRepresentation)
Get users Returns a list of users, filtered according to query parameters- Parameters:
firstResult
- Pagination offsetmaxResults
- Pagination sizebriefRepresentation
- Only return basic information (only guaranteed to return id, username, created, first and last name, email, enabled state, email verification state, federation link, and access. Note that it means that namely user attributes, required actions, and not before are not returned.)- Returns:
-
-