replaceUser #

Replaces an existing user.

replaceUser(id, content, [options], [callback]) #

Arguments	Type	Description
`id`	string	Unique user identifier
`content`	JSON Object	A plain JSON object representing the user, should contain the mandatory `profileIds` field
`options`	string	(Optional) Optional arguments
`callback`	function	(Optional) Callback handling the response

Options #

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

Return Value #

Returns the Security object to allow chaining.

Callback Response #

Returns a User object.

Usage #

var newContent = {
  profileIds: ['admin'],
  firstname: 'My Name Is',
  lastname: 'Jonas'
};
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .security
  .replaceUser("User ID", newContent, function (err, replacedUser) {
    // "replacedUser" is an instance of a User object
  });

Edit this page on Github