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.

getAllCredentialFields #

Retrieves the list of fields accepted by authentication strategies.


getAllCredentialFields([options]);

PropertyTypeDescription
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 with one property set per authentication strategy, each being an array of accepted field names.

Usage #

try {
  const response = await kuzzle.security.getAllCredentialFields();
  console.log(response);
  /*
  { local: [ 'username', 'password' ],
    facebook: [ ] }
   */
} catch (e) {
  console.error(e);
}