Authenticate API

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.

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:

resp = client.security.authenticate()
print(resp)

const response = await client.security.authenticate();
console.log(response);

GET /_security/_authenticate

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

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