honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Format the authenticate API (elastic/x-pack-elasticsearch#2572) 

Original commit: elastic/x-pack-elasticsearch@bc486dc6be
This commit is contained in:
Lisa Cawley 2017-09-22 10:07:15 -07:00 committed by GitHub
parent 62fbd5a798
commit 445af3ecf5
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/rest-api/security/authenticate.asciidoc
View File

@ -4,9 +4,24 @@
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:
==== Request
`GET _xpack/security/_authenticate`
==== Description
A successful call returns a JSON structure that shows what roles are assigned
to the user as well as any assigned metadata.
If the user cannot be authenticated, this API returns a 401 status code.
==== Examples
To authenticate a user, submit a GET request to the
`_xpack/security/_authenticate` endpoint:
[source,js]
--------------------------------------------------
@ -14,8 +29,7 @@ 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.
The following example output provides information about the "rdeniro" user:
[source,js]
--------------------------------------------------