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.

validateMyCredentials #

Validates the provided credentials against a specified authentication strategy.

This route neither creates nor modifies credentials.


validateMyCredentials(strategy, [credentials], [options]);

ArgumentsTypeDescription
strategy
string
Strategy to use
credentials
object
Credentials
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

Resolves #

Resolves to true if the credentials are valid, false otherwise.

Usage #

const credentials = { username: 'foo', password: 'bar' };
try {
  await kuzzle.auth.login('local', credentials);
  const valid = await kuzzle.auth.validateMyCredentials('local', credentials);
  if (valid === true) {
    console.log('Credentials are valid');
  }
} catch (error) {
  console.error(error.message);
}