Authenticate a user | Elasticsearch API documentation

Responses

200 application/json
Hide response attributes Show response attributes object
- api_keyobject
  Hide api_key attributes Show api_key attributes object
  idstring Required
  namestring
- authentication_realmobject Required
  Hide authentication_realm attributes Show authentication_realm attributes object
  namestring Required
  typestring Required
- emailstring | null
  One of:
  string-1string string-2string | null
- full_namestring | null
  One of:
  Namestring string-2string | null
- lookup_realmobject Required
  Hide lookup_realm attributes Show lookup_realm attributes object
  namestring Required
  typestring Required
- metadataobject Required
  Hide metadata attribute Show metadata attribute object
- rolesarray[string] Required
- usernamestring Required
- enabledboolean Required
- authentication_typestring Required
- tokenobject
  Hide token attributes Show token attributes object
  namestring Required
  typestring Generally available; Added in 7.14.0

GET /_security/_authenticate

GET /_security/_authenticate

resp = client.security.authenticate()

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

response = client.security.authenticate

$resp = $client->security()->authenticate();

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/_authenticate"

Response examples (200)

A successful response from `GET /_security/_authenticate`.

{
  "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"
}

Responses

emailstring | null

full_namestring | null