IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Authenticate API
editAuthenticate API
editThe Authenticate API enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user.
Request
editGET _xpack/security/_authenticate
Description
editA 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.
Examples
editTo authenticate a user, submit a GET request to the
_xpack/security/_authenticate endpoint:
GET _xpack/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" : "default_file",
"type" : "file"
},
"lookup_realm": {
"name" : "default_file",
"type" : "file"
}
}