SDK
SDK Javascript v5.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.

getCredentials #

Get credential information of user with kuid for the specified strategy.


getCredentials(strategy, kuid, [options], callback) #

ArgumentsTypeDescription
strategystringStrategy you want to get credentials from
kuidstringUser's kuid
optionsJSON objectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

The result is a an object with the credentials.

Usage #

// Using callbacks (node.js or browser)
kuzzle.security.getCredentials('local', 'kuid', function (error, credentials) {
});
// Using promises (node.js)
kuzzle
  .security
  .getCredentialsPromise('local', 'kuid')
  .then(credentials => {
  });

Callback response

{
  "username": "foo",
  "kuid": "<Kuzzle User Unique Identifier>"
}