Unknown SDK


Create a new restricted user in Kuzzle. This function allows anonymous users to create a "restricted" user with predefined rights.

There is a small delay between user creation and its availability in our search layer (usually a couple of seconds). That means that a user that was just created may not be returned immediately by the searchUsers function.

createRestrictedUser(id, content, [options], [callback])

Arguments Type Description
id string Unique user identifier, will be used as username
content JSON Object A plain JSON object representing the user
options string (Optional) Optional arguments
callback function Callback handling the response


Filter Type Description Default
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait the persistence layer indexation to return (available with Elasticsearch 5.x and above) undefined

Callback response

Resolves to a User object.


Copied to clipboard!
use \Kuzzle\Kuzzle;
use \Kuzzle\Security\User;
$kuid = 'myUser';
$userDefinition = [
  'content' => [
  'credentials' => [
    'local' => [
      // The "local" authentication strategy requires a password
      'password' => 'secretPassword',
      'lastLoggedIn' => 1494411803
$kuzzle = new Kuzzle('localhost');
$security = $kuzzle->security();
try {
  $user = $security->createRestrictedUser($kuid, $userDefinition);
  // $user instanceof User
catch (ErrorException $e) {