Unknown SDK

getAllCredentialFields

Retrieves the list of fields accepted by authentication strategies.


Copied to clipboard!
getAllCredentialFields([options]);

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

Usage

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