GET api/teams/User/GetUserListByFilteredDomain?userFilter={userFilter}&filterByAnalyst={filterByAnalyst}&groupsOnly={groupsOnly}&maxNumberOfResults={maxNumberOfResults} Returns a list of users with minimal properties filtered by domain.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userFilter |
A text string used to filter users. |
string |
Default value is |
filterByAnalyst |
Boolean used to filter by Analysts only, Default = false |
boolean |
Default value is False |
groupsOnly |
Boolean used to filter by Groups only, Default = false |
boolean |
Default value is False |
maxNumberOfResults | integer |
Default value is 10 |
Body Parameters
None.Response Information
Resource Description
Collection of ConsoleUserMinimalName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "82c9a912-6152-456c-b8fa-b8344c4b477b", "Name": "sample string 2", "Email": "sample string 3" }, { "Id": "82c9a912-6152-456c-b8fa-b8344c4b477b", "Name": "sample string 2", "Email": "sample string 3" } ]
application/xml, text/xml
Sample:
<ArrayOfConsoleUserMinimal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Library"> <ConsoleUserMinimal> <Email>sample string 3</Email> <Id>82c9a912-6152-456c-b8fa-b8344c4b477b</Id> <Name>sample string 2</Name> </ConsoleUserMinimal> <ConsoleUserMinimal> <Email>sample string 3</Email> <Id>82c9a912-6152-456c-b8fa-b8344c4b477b</Id> <Name>sample string 2</Name> </ConsoleUserMinimal> </ArrayOfConsoleUserMinimal>