SearchUserIdentities REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
SearchUserIdentities
Queries the UserIdentity search index.
Applicable to: the UserIdentity sv:applicationIndex.
GET
Returns an array of objects containing information about sv:userIdentity based on a Solr query.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is authorized to READ on the sv:site.
| Name | Type | Default | Description |
|---|---|---|---|
| query | string |
A valid Solr query | |
| filterQuery | string |
A valid Solr query | |
| maxHits | number |
10 | A maximum number of hits to return. (Since 2022.10.2: the maxHits value must be in range [1..500]. A value that is out of range will be trimmed into range) |
| startAt | number |
0 | A number of hits to skip. (The startAt value must be zero or positive. A negative value will be treated as zero) |
| fields | array |
An array of fields to include in the result | |
| sortFields | array |
An array of objects with name (string) and sort order (boolean) [
{
"name": "name.sortable",
"desc": true
}
]
|
Example input
{
"query": "+name.analyzed:magnus",
"filterQuery": "+userfield.department:Headquarter",
"maxHits": 5,
"fields": [
"id", "name", "mail", "userfield.title"
],
"sortFields": [
{
"name": "name.sortable",
"desc": false
},
{
"name": "userfield.sortable.title",
"desc": false
}
]
}
Did you find the content on this page useful?