mDeleteUsers #

Deletes multiple users.

Throws a partial error (error code 206) if one or more user deletions fail.

mDeleteUsers(kuids, [options]);

Property	Type	Description
`kuids`	array<string>	Array of user kuid
`options`	object	Query options

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 users deletion is indexed
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

An array of the deleted user ids.

Usage #

try {
  const response = await kuzzle.security.mDeleteUsers([
    'user1',
    'user2',
    'user3'
  ]);
  console.log(response);
  /*
  [ 'user1', 'user2', 'user3' ]
    */
} catch (e) {
  console.error(e);
}

Edit this page on Github