validateCredentials #

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

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:

{
  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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

A |

boolean

telling whether credentials are valid.

Usage #

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

Edit this page on Github