Resource: Users and Group Search ( /api/usergroupsearch )
Allows the searching of all users and groups by partial match.
Root Relation: UserGroupSearch
This resource supports the following methods: GET, POST
Methods
GET
Searches for users or groups by partial name match
Required Permissions
- TestManagement/ManageExecutions/View
- TestManagement/ManageIncidents/View
- TestManagement/ManageRequirements/View
- TestManagement/ManageScripts/View
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the search request was able to be satisfied. |
Example - Search for users
An example of searching for users.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Request Parameters
| Key | Value | Description |
|---|---|---|
| query | jo | The partial username, firstname or lastname to search for |
| $skip | 20 | Number of items to skip (start result number) |
| $top | 10 | Number of search results to return |
| $inlinecount | allpages | Include or supress inline counts |
| $expand | DisplayName | Allows expansion of additional user properties |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Skip": 20,
"Top": 10,
"Total": 1,
"Items": [
{
"Id": "3464e9da-f1b7-49aa-87db-7e1eebfd17a5",
"UserName": "joeb",
"Email": "joeb@unknown.net",
"FirstName": "Joe",
"LastName": "Bloggs",
"Phone": "(09)-555-999",
"LastLogIn": null,
"Enabled": true,
"IsExternal": false,
"DisplayName": "Joe Bloggs (joeb)",
"Self": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5",
"Links": [
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/password",
"Rel": "ChangePassword"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Title": "Group Memberships",
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/groups",
"Rel": "Groups"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/notifications",
"Rel": "Notifications"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/permissions/projects",
"Rel": "ProjectPermissions"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/mailmessages",
"Rel": "MailMessages"
}
]
}
],
"Self": "http://localhost/api/usergroupsearch/assignees?query=jo&$skip=20&$top=10&$inlinecount=allpages",
"Links": [
{
"Href": "http://localhost/api/usergroupsearch/assignees?query=jo&$skip=10&$top=10&$inlinecount=allpages",
"Rel": "prev"
},
{
"Href": "http://localhost/api/usergroupsearch/assignees?query=jo&$skip=0&$top=10&$inlinecount=allpages",
"Rel": "first"
}
]
}
Status Code
200 - OK
POST
Searches for users or groups by partial name match (using POST to allow large existing value queries).
Required Permissions
- TestManagement/ManageExecutions/View
- TestManagement/ManageIncidents/View
- TestManagement/ManageRequirements/View
- TestManagement/ManageScripts/View
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the search request was able to be satisfied. |
Example - Search for users
An example of searching for users.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/x-www-form-urlencoded |
Request Parameters
| Key | Value | Description |
|---|---|---|
| query | jo | The partial username, firstname or lastname to search for |
| $skip | 20 | Number of items to skip (start result number) |
| $top | 10 | Number of search results to return |
| $inlinecount | allpages | Include or supress inline counts |
| $expand | DisplayName | Allows expansion of additional user properties |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Skip": 20,
"Top": 10,
"Total": 1,
"Items": [
{
"Id": "3464e9da-f1b7-49aa-87db-7e1eebfd17a5",
"UserName": "joeb",
"Email": "joeb@unknown.net",
"FirstName": "Joe",
"LastName": "Bloggs",
"Phone": "(09)-555-999",
"LastLogIn": null,
"Enabled": true,
"IsExternal": false,
"DisplayName": "Joe Bloggs (joeb)",
"Self": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5",
"Links": [
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/password",
"Rel": "ChangePassword"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Title": "Group Memberships",
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/groups",
"Rel": "Groups"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/notifications",
"Rel": "Notifications"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/permissions/projects",
"Rel": "ProjectPermissions"
},
{
"Href": "http://localhost/api/user/3464e9da-f1b7-49aa-87db-7e1eebfd17a5/mailmessages",
"Rel": "MailMessages"
}
]
}
],
"Self": "http://localhost/api/usergroupsearch/assignees?$skip=20&$top=10&$inlinecount=allpages",
"Links": [
{
"Href": "http://localhost/api/usergroupsearch/assignees?$skip=10&$top=10&$inlinecount=allpages",
"Rel": "prev"
},
{
"Href": "http://localhost/api/usergroupsearch/assignees?$skip=0&$top=10&$inlinecount=allpages",
"Rel": "first"
}
]
}
Status Code
200 - OK