SDK
SDK Javascript v7.x
2

credentialsExist #

Checks that the current authenticated user has credentials for the specified authentication strategy.


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

Arguments Type Description
local
string
Strategy to use
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
timeout
number
Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely

Resolves #

Resolves to true if the credentials exist, false otherwise.

Usage #

Copied to clipboard!
const credentials = { username: 'foo', password: 'bar' };
try {
  await kuzzle.auth.login('local', credentials);
  const exists = await kuzzle.auth.credentialsExist('local');
  if (exists === true) {
    console.log('Credentials exist');
  }
} catch (error) {
  console.error(error.message);
}