mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-11 23:45:15 +00:00
9f7f8ffb4d
Docs for security features in 5.4 - `has_privileges` API - ldap metadata. Original commit: elastic/x-pack-elasticsearch@22c733c814
32 lines
890 B
Plaintext
32 lines
890 B
Plaintext
[[security-api-authenticate]]
|
|
=== Authenticate API
|
|
|
|
The Authenticate API enables you to submit a request with a basic auth header to
|
|
authenticate a user and retrieve information about the authenticated user.
|
|
Returns a 401 status code if the user cannot be authenticated.
|
|
|
|
To authenticate a user, submit a GET request to the `_xpack/security/_authenticate` endpoint:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _xpack/security/_authenticate
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
A successful call returns a JSON structure that shows what roles are assigned
|
|
to the user as well as any assigned metadata.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"username": "rdeniro",
|
|
"roles": [
|
|
"admin",
|
|
"kibana4"
|
|
],
|
|
"metadata" : {
|
|
"employee_id": "8675309"
|
|
}
|
|
}
|
|
--------------------------------------------------
|