SDK
SDK Javascript v7.x
2

deleteUser #

Deletes a user and all their associated credentials.


Copied to clipboard!
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

Resolves #

An object containing the kuid of the deleted user in its _id property.

Usage #

Copied to clipboard!
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);
}