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.

getMyCredentials #

Returns credentials information for the currently logged in user.

The returned data depends on the given authentication strategy, and should never include any sensitive information.

The result can be an empty object.


getMyCredentials(strategy, [options]);

ArgumentsTypeDescription
strategy
string
Strategy to use
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 #

An object representing the credentials for the provided authentication strategy. Its content depends on the authentication strategy.

Usage #

const credentials = { username: 'foo', password: 'bar' };
try {
  await kuzzle.auth.login('local', credentials);
  const localCredentials = await kuzzle.auth.getMyCredentials('local');
  console.log(localCredentials);
  /*
    { username: 'foo', kuid: 'AVkDBl3YsT6qHI7MxLz0' }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}