validateMyCredentials #
Validates the provided credentials against a specified authentication strategy.
This route neither creates nor modifies credentials.
Query Syntax #
HTTP #
Available since 2.4.0
URL: http://kuzzle:7512/_me/credentials/<strategy>/_validate
Method: POST
Headers: Authorization: "Bearer <authentication token>"
Body:
Deprecated since 2.4.0
URL: http://kuzzle:7512/credentials/<strategy>/_me/_validate
Method: POST
Headers: Authorization: "Bearer <authentication token>"
Body:
{
"username": "MyUser",
"password": "MyPassword"
}
Other protocols #
{
"controller": "auth",
"action": "validateMyCredentials",
"strategy": "<strategy>",
"jwt": "<authentication token>",
"body": {
"username": "MyUser",
"password": "MyPassword"
}
}
Arguments #
jwt
: valid authentication token (for the HTTP protocol, the token is to be passed to theAuthorization
header instead)strategy
: name of the authentication strategy used to validate the provided credentials
Body properties #
Credentials to validate. The properties to send will depend on the chosen authentication strategy.
Examples in this page are for the local
authentication plugin.
Response #
Returns a boolean telling whether the provided credentials are valid:
{
"status": 200,
"error": null,
"action": "validateMyCredentials",
"controller": "auth",
"result": true
}
Edit this page on Github (opens new window)