SDK
SDK Javascript v7.x
2

# validateCredentials

Checks if the provided credentials are well-formed. Does not actually save credentials.


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

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

# credentials

The credentials to check. 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

# Resolves

A |

boolean
telling whether credentials are valid.

# Usage

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