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.

getCredentialFields #

Get credential information for the specified strategy.


getCredentialFields(strategy, [options], callback) #

ArgumentsTypeDescription
strategystringStrategy you want to get credentials from
optionsJSON objectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

The result is a an array of credential fields.

Usage #

// Using callbacks (node.js or browser)
kuzzle.security.getCredentialFields('local', function (error, fields) {
});
// Using promises (node.js)
kuzzle
  .security
  .getCredentialFieldsPromise('local')
  .then(fields => {
  });

Callback response:

["kuid", "username"]