SDK
SDK Javascript v7.x
2

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
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 #

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);
}