public interface UserResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
UserLoadResponse |
getMe(boolean groups)
Get the current user (me)
By default, the user's groups are not returned.
|
UserListResponse |
list(Integer skipCount,
Integer maxItems,
List<Integer> ids,
List<String> logins,
List<String> firstNames,
List<String> lastNames,
List<String> eMails,
List<Integer> groupIds,
String search,
UserSortAttribute sortBy,
SortOrder sortOrder,
boolean addGroups)
Get a list of users, optionally filtered, sorted and paged
|
setSessionId
UserLoadResponse getMe(boolean groups)
groups
- Whether to list the user's groupsUserListResponse list(Integer skipCount, Integer maxItems, List<Integer> ids, List<String> logins, List<String> firstNames, List<String> lastNames, List<String> eMails, List<Integer> groupIds, String search, UserSortAttribute sortBy, SortOrder sortOrder, boolean addGroups)
skipCount
- number of elements to be skipped (paging)maxItems
- maximum number of elements returned (paging)ids
- id(s) for filteringlogins
- login string(s) for filteringfirstNames
- firstname string(s) for filteringlastNames
- lastname string(s) for filteringeMails
- email string(s) for filteringgroupIds
- group id(s) for filteringsearch
- additionally search in users logins, firstNames, lastNames and
emailssortBy
- name of an attribute to sortsortOrder
- sort orderaddGroups
- true to add groups to the users, false (default) otherwiseCopyright © 2015 Gentics Software. All rights reserved.