Interface GroupResource


  • public interface GroupResource
    Version:
    $Revision: 1 $
    Author:
    Bill Burke
    • Method Detail

      • 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 -
      • 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 offset
        maxResults - 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 offset
        maxResults - Pagination size
        briefRepresentation - 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: