Core
API v1.x
1

# validateMyCredentials

Validates the provided credentials against a specified authentication strategy.

This route neither creates nor modifies credentials.


# Query Syntax

# HTTP

Copied to clipboard!
URL: http://kuzzle:7512/credentials/<strategy>/_me/_validate
Method: POST
Headers: Authorization: "Bearer <authentication token>"
Body:
Copied to clipboard!
{
  "username": "MyUser",
  "password": "MyPassword"
}

# Other protocols

Copied to clipboard!
{
  "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 the Authorization 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:

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "action": "validateMyCredentials",
  "controller": "auth",
  "result": true
}