Skip to content

Commit

Permalink
Merge pull request #159 from flimzy/authclarify
Browse files Browse the repository at this point in the history
Clarify and expand on GET /_session response
  • Loading branch information
flimzy committed Aug 22, 2017
2 parents f7840d7 + ad5d1dc commit 1ef1f1b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/api/server/authn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,15 @@ To obtain the first token and thus authenticate a user for the first time, the
.. http:get:: /_session
:synopsis: Returns Cookie-based login user information

Returns complete information about authenticated user.
This information contains :ref:`userctx_object`, authentication method and
available ones and authentication database.
Returns information about the authenticated user, including a
:ref:`userctx_object`, the authentication method and database that were
used, and a list of configured authentication handlers on the server.

:query boolean basic: Accept `Basic Auth` by requesting this resource.
*Optional*.
:>json boolean ok: Operation status
:>json object userCtx: User context for the current user
:>json object info: Server authentication configuration
:code 200: Successfully authenticated.
:code 401: Username or password wasn't recognized.

Expand Down

0 comments on commit 1ef1f1b

Please sign in to comment.