SDK
SDK PHP v3.x
1

# scrollUsers

Scrolls on stored users using the provided scroll ID.


# scrollUsers(scrollId, [options], callback)

Arguments Type Description
scrollId string Scroll identifier retrieved from a search query
options JSON Object Optional parameters
callback function Callback handling the response

# Options

Option Type Description Default
queuable boolean Make this request queuable or not true

# Callback Response

Returns the list of fetched users according to the scroll parameters (offset, limit etc.).

# Usage

Copied to clipboard!
<?php
use \Kuzzle\Kuzzle;
$scrollId = 'myScrollId';
$options = [];
$kuzzle = new Kuzzle('localhost');
try {
  $kuzzle->security()->scrollUsers($profileId, $options);
}
catch (ErrorException $e) {
  // Handle error
}