Interface GroupService

All Superinterfaces:
Service

public interface GroupService extends Service
Provides methods to retrieve GetGroupsResponse and check user membership in group.
  • Method Details

    • getGroupsByNames

      GetGroupsResponse getGroupsByNames(List<String> groupNames)
      Retrieves GetGroupsResponse for the given List of group names.
      Parameters:
      groupNames - List of group names, maximum 500. Invalid names are ignored. Cannot be null.
      Returns:
      GetGroupsResponse object
    • getGroupsbyIds

      GetGroupsResponse getGroupsbyIds(List<String> groupIds)
      Retrieves GetGroupsResponse for the given List of group IDs.
      Parameters:
      groupIds - List of group ids, maximum 500. Invalid ids are ignored. Cannot be null.
      Returns:
      GetGroupsResponse object
    • isUserInGroup

      boolean isUserInGroup(String userId, Group group)
      Check if a user belongs to a group. Implied users are also checked, for example, users from an associated security profile.
      Parameters:
      userId - id of the user to check. Cannot be null.
      group - Group object. Cannot be null.
      Returns:
      true if the user belongs to the group, otherwise false