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"]
}