SDK
SDK Javascript v6.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

replaceUser #

Replaces a user with new configuration.


Copied to clipboard!
replaceUser(kuid, body, [options]);

Property Type Description
kuid
string
User kuid
body
object
User content
options
object
Query options

body #

mandatory properties

Property Type Description
profileIds
array<string>
Profile identifiers to assign the user to

other properties

The body can be extended with any custom information. Make sure to update the user mapping collection to match your custom attributes.

example:

Copied to clipboard!
{
  profileIds: [ 'default' ],
  firstName: 'John',
  lastName: 'Doe'
}

options #

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again
refresh
boolean

(false)
If set to wait_for, Kuzzle will not respond until the created user is indexed

Resolves #

An User object containing information about the updated user.

Usage #

Copied to clipboard!
try {
  const response = await kuzzle.security.replaceUser('john.doe', {
    profileIds: [ 'default' ],
    firstName: 'John',
    lastName: 'Doe'
  });
  console.log(response);
  /*
  User {
    _id: 'john.doe',
    content:
      { profileIds: [ 'default' ],
        firstName: 'John',
        lastName: 'Doe',
        _kuzzle_info:
          { author: -1,
            createdAt: 1561461975256,
            updatedAt: null,
            updater: null } } }
   */
} catch (e) {
  console.error(e);
}