User Search API
The FLOW User Search API provides an endpoint to search the CMS users in FLOW.
Endpoint
/api/roles
/api/user-search/{publicationDomain}
where publicationDomain is the domain e.g. example.com
Roles
Returns a keyed array of User Roles as an object, the key is the machine name which is what the Search API expects, the value is the human-readable name.
https://indy-api-dev.brightsites.co.uk/api/roles
Search
Simple elastic search endpoint for searching the user entities
Search Arguments
| Arguments | Description | Example |
|---|---|---|
| q | Query for Name | Test Search |
| limit | Set the number of users to be return | 20 |
| offset | Set the offset e.g. return users from position 40 | 40 |
| sort | Any of the numeric fields on the user object, eg, access | changed |
| direction | asc or desc | desc |
| role | The machine name of a role, eg: cms_editor, cms_admin | cms_editor |
| status | Optional, filters by status when set, values are 0 or 1 | 1 |
Full API call based on example below:
https://indy-api-dev.brightsites.co.uk/api/user-search/independent.co.uk?sort=created&direction=DESC&q=Simon&role=cms_editor&status=1&limit=1&offset=1