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.

updateCredentials #

Updates a user credentials for the specified authentication strategy.


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

Property Type Description
strategy
string
Strategy to use
kuid
string
User kuid
credentials
object
New credentials
options
object
Query options

credentials #

The credentials to send. The expected properties depend on the target authentication strategy.

Example for the local strategy:

Copied to clipboard!
{
  username: 'foo',
  password: 'bar'
}

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 are indexed

Resolves #

An object representing the new credentials.
The content depends on the authentication strategy.

Usage #

Copied to clipboard!
try {
  const response = await kuzzle.security.updateCredentials(
    'local',
    'john.doe',
    {
      username: 'jdoe',
      password: 'newPassword'
    }
  );
  console.log(response);
  /*
  { username: "jdoe" }
    */
} catch (e) {
  console.error(e);
}