Core
API v1.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.


Query Syntax #

HTTP #

URL: http://kuzzle:7512/credentials/_fields
Method: GET

Other protocols #

{
  "controller": "security",
  "action": "getAllCredentialFields"
}

Response #

Returns an object with a property per authentication strategy, pointing to an array of accepted field names.

{
  "status": 200,
  "error": null,
  "action": "getAllCredentialFields",
  "controller": "security",
  "result": {
    "local": ["username", "password"],
    "facebook": []
  }
}