searchUsers

Return users matching the given filter.


searchUsers(filters, [options], callback)

Arguments Type Description
filters JSON Object Filter in Elasticsearch's Query DSL format
options JSON Object Optional parameters
callback function Callback handling the response

Options

Option Type Description Default
from number Starting offset 0
queuable boolean Make this request queuable or not true
scroll string Start a scroll session, with a time to live equals to this parameter's value following the Elastisearch time format undefined
size number Number of hits to return per result page 10

To get more information about scroll sessions, please refer to the API reference documentation.


Callback Response

Return a JSON Object

Usage

Copied to clipboard!

<?php

use \Kuzzle\Kuzzle;
use \Kuzzle\Security\User;
use \Kuzzle\Util\UsersSearchResult;

$filters = [
  'bool' => [
    'must' => [
      [
        'terms' => [
          'profileIds' => ['anonymous', 'default'],
        ]
      ],
      [
        'geo_distance' => [
          'distance' => '10km',
          'pos' => [
            'lat' => 48.8566140,
            'lon' => 2.352222
          ]
        ]
      ]
    ]
  ]
];

// optional: result pagination configuration
$options = [
  'from' => 0,
  'size' => 1,
  'scroll' => '1m'
];

$kuzzle = new Kuzzle('localhost');
$security = $kuzzle->security();

try {
  $result = $security->searchUsers($filters, $options);

  // $result instanceof UsersSearchResult

  foreach($result->getUsers() as $user) {
    // $user instanceof User
  }
}
catch (ErrorException $e) {

}

Callback response:

Copied to clipboard!
{
  "total": 124,
  "users": [
    // array of User objects
  ],
  // only if a scroll parameter has been provided
  "scrollId": "<scroll identifier>"
}