validateMyCredentials #
Validates the provided credentials against a specified authentication strategy.
This route neither creates nor modifies credentials.
validateMyCredentials(strategy, [credentials], [options]);
Arguments | Type | Description |
---|---|---|
strategy | string | Strategy to use |
credentials | object | Credentials |
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 |
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);
}
Edit this page on Github(opens new window)