Authenticate a user | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Authenticate a user Added in 5.5.0

GET /_security/_authenticate

Authenticates a user and returns information about the authenticated user. Include the user information in a basic auth header. 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.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • Hide api_key attributes Show api_key attributes object
  • Hide authentication_realm attributes Show authentication_realm attributes object
  • Hide lookup_realm attributes Show lookup_realm attributes object
  • Hide metadata attribute Show metadata attribute object
    * *
    object Additional properties
  • roles
    array[string] Required
  • Hide token attributes Show token attributes object