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.

deleteCredentials #

Deletes user credentials for the specified authentication strategy.


deleteCredentials(strategy, kuid, [options]);

PropertyTypeDescription
strategy
string
Strategy to use
kuid
string
User kuid
options
object
Query options

options #

Additional query options

PropertyType
(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 credentials deletion is indexed

Resolves #

An acknowledgment message.

Usage #

try {
  const response = await kuzzle.security.deleteCredentials('local', 'john.doe');
  console.log(response);
  /*
  { acknowledged: true }
    */
  console.log('Credentials successfully deleted');
} catch (e) {
  console.error(e);
}