scrollUsers

Moves a result set cursor forward, created by a searchUsers query with the scroll argument provided.

Results returned by a scrollUsers request reflect the state of the index at the time of the initial search request, like a fixed snapshot. Subsequent changes to documents do not affect the scroll results.


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/users/_scroll/<scrollId>[?scroll=<time to live>]
Method: GET

Other protocols

Copied to clipboard!
{
  "controller": "security",
  "action": "scrollUsers",
  "scrollId": "<scrollId>",
  "scroll": "<time to live>"
}

Arguments

  • scrollId: cursor unique identifier, obtained by either a searchUsers or a scrollUsers query

Optional:

  • scroll: refresh the cursor duration, using the time to live syntax.

Response

Returns a paginated search result set, with the following properties:

  • hits: array of found profiles. Each document has the following properties:
    • _id: user kuid
    • _source: user definition
  • scrollId: identifier to the next page of result. Can be different than the previous one(s)
  • total: total number of found users. Usually greater than the number of users in a result page
Copied to clipboard!
{
  "status": 200,
  "error": null,
  "action": "scrollUsers",
  "controller": "security",
  "requestId": "<unique request identifier>",
  "result": {
    "scrollId": "<new scroll id>",
    "hits": [
      {
        "_id": "kuid1",
        "_source": {
          "profileIds": [{"roleId": "default"}],
          "fullname": "John Doe"
        }
      },
      {
        "_id": "kuid2",
        "_source": {
          "profileIds": [{"roleId": "admin"}],
          "fullname": "Beardy McBeardface"
        }
      }
    ],
    "total": 42
  }
}