com.gentics.contentnode.rest.resource
Interface UserResource

All Superinterfaces:
AuthenticatedResource

public interface UserResource
extends AuthenticatedResource

Resource to get Users. The list of users returned will always be filtered by user permission: A user may only see users that are members of the same groups or subgroups of the groups, the user is member of


Method Summary
 UserLoadResponse getMe()
          Get the current user (me)
 UserListResponse list(Integer skipCount, Integer maxItems, List<Integer> ids, List<String> logins, List<String> firstNames, List<String> lastNames, List<String> eMails, List<Integer> groupIds, UserSortAttribute sortBy, SortOrder sortOrder)
          Get a list of users, optionally filtered, sorted and paged
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

getMe

UserLoadResponse getMe()
Get the current user (me)

Returns:
current user

list

UserListResponse list(Integer skipCount,
                      Integer maxItems,
                      List<Integer> ids,
                      List<String> logins,
                      List<String> firstNames,
                      List<String> lastNames,
                      List<String> eMails,
                      List<Integer> groupIds,
                      UserSortAttribute sortBy,
                      SortOrder sortOrder)
Get a list of users, optionally filtered, sorted and paged

Parameters:
skipCount - number of elements to be skipped (paging)
maxItems - maximum number of elements returned (paging)
ids - id(s) for filtering
logins - login string(s) for filtering
firstNames - firstname string(s) for filtering
lastNames - lastname string(s) for filtering
eMails - email string(s) for filtering
groupIds - group id(s) for filtering
sortBy - name of an attribute to sort
sortOrder - sort order
Returns:
list of users


Copyright © 2013 Gentics Software GmbH. All Rights Reserved.