Core 2.x

deleteCredentials

Deletes user credentials for the specified authentication strategy.


Copied to clipboard!
deleteCredentials(strategy, kuid, [options]);

Property Type Description
strategy
string
Strategy to use
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 credentials deletion is indexed

Resolves

An acknowledgment message.

Usage

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