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.

getCredentialFields #

Retrieves the list of accepted field names by the specified authentication strategy


Copied to clipboard!
getCredentialFields(strategy, [options]);

Property Type Description
strategy
string
Strategy identifier
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 #

An array ofr accepted field names.

Usage #

Copied to clipboard!
try {
  const response = await kuzzle.security.getCredentialFields('local');
  console.log(response);
  /*
  [ 'username', 'password' ]
    */
} catch (e) {
  console.error(e);
}