Interface GroupService

  • All Known Implementing Classes:
    GroupServiceImpl

    public interface GroupService
    API service for finding user groups in confluence. Membership of a group can confer permissions and the ability to perform various operations to a user.
    Since:
    5.10
    • Method Detail

      • find

        GroupService.GroupFinder find​(Expansion... expansions)
        Create a GroupFinder for locating groups, the expansions will be applied to each group that matches the finder. No expansions are currently supported on groups. Groups will be retrieved by using the fetch methods on the returned GroupFinder.

        For example, to fetch a group called "developers"

             groupService.find()
             .withName("developers")
             .fetchOneOrNull();
             
         
        Parameters:
        expansions -
        Returns:
        a groupFinder for locating groups
      • validator

        GroupService.Validator validator()
        Get the validator view of the GroupService.
        Returns:
        a Validator that can be used to validate service requests.
      • createGroup

        Group createGroup​(String groupName)
        Create a new Group identified by groupName.
        Parameters:
        groupName - The name identifying the new group to create.
        Since:
        8.2.0
      • deleteGroup

        void deleteGroup​(String groupName)
        Delete an existing Group identified by groupName.
        Parameters:
        groupName - The name identifying the existing group to delete.
        Since:
        8.2.0