getAllCredentialFields #
Retrieves the list of fields accepted by authentication strategies.
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 |
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 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);
}
Edit this page on Github(opens new window)