Authenticate API

Authenticate API

New API reference

For the most up-to-date API details, refer to Security APIs.

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

Request

GET /_security/_authenticate

Description

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 codes

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

Examples

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

  1. resp = client.security.authenticate()
  2. print(resp)
  1. const response = await client.security.authenticate();
  2. console.log(response);
  1. GET /_security/_authenticate

The following example output provides information about the “rdeniro” user:

  1. {
  2.   "username": "rdeniro",
  3.   "roles": [
  4.     "admin"
  5.   ],
  6.   "full_name": null,
  7.   "email":  null,
  8.   "metadata": { },
  9.   "enabled": true,
  10.   "authentication_realm": {
  11.     "name" : "file",
  12.     "type" : "file"
  13.   },
  14.   "lookup_realm": {
  15.     "name" : "file",
  16.     "type" : "file"
  17.   },
  18.   "authentication_type": "realm"
  19. }