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.

getCredentialFields #

Retrieves the list of accepted field names by the specified authenticaiton strategy.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/credentials/<strategy>/_fields
Method: GET

Other protocols #

Copied to clipboard!
{
  "controller": "security",
  "action": "getCredentialFields",
  "strategy": "<strategy>"
}

Arguments #

  • strategy: authentication strategy

Response #

Returns an array of accepted field names.

Example with the "local" authentication strategy: #

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "action": "getCredentialFields",
  "controller": "security",
  "result": ["username", "password"]
}