SDK
SDK Javascript v7.x
2

getCredentialFields #

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


getCredentialFields(strategy, [options]);

PropertyTypeDescription
strategy
string
Strategy identifier
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 array ofr accepted field names.

Usage #

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