deleteUser #

Deletes a user and all their associated credentials.

deleteUser(kuid, [options]);

Property	Type	Description
`kuid`	string	User kuid
`options`	object	Query options

options #

Additional query 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 user 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 object containing the kuid of the deleted user in its _id property.

Usage #

try {
  const response = await kuzzle.security.deleteUser('john.doe');
  console.log(response);
  /*
  { _id: 'john.doe' }
    */
  console.log('User successfully deleted');
} catch (e) {
  console.error(e);
}

Edit this page on Github