How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
Invoke this operation to get a list of user defined on the system.
API Details
- Status:
- The required privilege level to invoke this method is
user
- The supported database role for this method is
slave
System Rights | Database Rights | Mail Rights | Calendar Rights |
---|---|---|---|
sys.a.manageUsers |
--- |
--- |
--- |
Request Parameters
The userGetList method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.
Name | Type | Attributes | Description |
---|---|---|---|
user |
xs:string |
Optional | Filter list by User ID or Login ID or Name or First Name or Last Name that starts with the specified string. |
userType |
accountUserType |
Optional | Filter list by type of user, can be ‘basic’ or ‘user’. If not specified then both ‘basic’ and ‘user’ types are returned. |
accountStatus |
Array<accountStatusType> |
Optional | Filter list by the specified account status type(s). If none specified then there is no filtering by account status type. |
order |
userListOrderBy |
Optional | Specify the order of users in the list |
pageInfo |
pageInfoType |
Optional | Controls the paging. If element is not specified, paging is disabled. |
Response Parameters
Name | Type | Attributes | Description |
---|---|---|---|
userListItem |
Array<userListType> |
Optional | The list of users. |
maxPages |
numberType |
Optional | A number indicating the maximum number of pages that could be returned. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document