Search access entity
Searches the specified access entity (user/group) in Rev for a specified query string. If no entity is specified, then both are searched.
Body Parameters
| Parameter | Type | Validations |
|---|---|---|
| type | string, optional | Type of access entity to search (user/group). More than one may be specified. If no type is specified, both will be searched. |
| q | string, optional | Search string to search. If no search string is provided, the search is treated as a blank search. For example, if the Group parameter is specified with no search string, the first 1000 Groups will be returned (count parameter default) with no specific search. |
| scrollId | string, optional |
The scrollId returned in the first search request. This can be passed in subsequent fetch requests to return the next set of results. This is forward only and you cannot get back the search results that are scrolled once. Note: There is a 60 second expiration on this parameter that is renewed each time it is used. If not used within 60 seconds of the first call, it expires. |
| count | integer, optional | The number of results to return. Be default, count is set to 1000 which is also the maximum amount of results that may be returned. If more than 1000 results are returned, only the first 1000 are displayed. |
Response Body
Successful response
{
"accessEntities": [
{
"Name": "Sales Group",
"Id": "6aa49448-b866-412d-89b0-9ceb49f8afbd",
"EntityType": "Group"
},
{
"UserName": "john.smith",
"FirstName": "John",
"LastName": "Smith",
"Email": "john.smith@company.com",
"Id": "094146e3-9971-45f6-80df-d918dc0fabdd",
"EntityType": "User"
} ],
"totalEntities": 2,
"scrollId": "cXVlcnlBbmRGZXRjaDsxOzM2ODpJcmhxdnN0NlJXQ0NCOWFpaXlrZzlROzA7"
}
Unauthorized error
ScrollId expired
Internal server error