Authenticate APIedit

Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.


GET /_security/_authenticate


A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.

Response codesedit

If the user cannot be authenticated, this API returns a 401 status code.


To authenticate a user, submit a GET request to the /_security/_authenticate endpoint:

GET /_security/_authenticate

The following example output provides information about the "rdeniro" user:

  "username": "rdeniro",
  "roles": [
  "full_name": null,
  "email":  null,
  "metadata": { },
  "enabled": true,
  "authentication_realm": {
    "name" : "file",
    "type" : "file"
  "lookup_realm": {
    "name" : "file",
    "type" : "file"
  "authentication_type": "realm"