Package com.veeva.vault.sdk.api.group
Interface GroupService
- All Superinterfaces:
Service
Provides methods to retrieve
GetGroupsResponse
and check user membership in group.-
Method Summary
Modifier and TypeMethodDescriptiongetGroupsbyIds
(List<String> groupIds) RetrievesGetGroupsResponse
for the given List of group IDs.getGroupsByNames
(List<String> groupNames) RetrievesGetGroupsResponse
for the given List of group names.boolean
isUserInGroup
(String userId, Group group) Check if a user belongs to a group.
-
Method Details
-
getGroupsByNames
RetrievesGetGroupsResponse
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
RetrievesGetGroupsResponse
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
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
-