doc/api/reference/auth.rst

   1 Authentication API
   2 ==================
   3
   4 Login / Verify Login
   5 --------------------
   6
   7 ..  http:post:: /api/2/auth/(username)/login.json
   8     :synopsis: verify the login status
   9
  10     * since 2.10
  11
  12     Log in the given user for the given device via HTTP Basic Auth.
  13
  14     :param username: the username which should be logged in
  15     :status 401: If the URL is accessed without login credentials provided
  16     :status 400: If the client provides a cookie, but for a different username than the one given
  17     :status 200: the response headers have a ``sessionid`` cookie set.
  18
  19     The client can use this URL with the cookie in the request header to check
  20     if the cookie is still valid.
  21
  22
  23 Logout
  24 ------
  25
  26 ..  http:post:: /api/2/auth/(username)/logout.json
  27     :synopsis: logout
  28
  29     * since 2.10
  30
  31     Log out the given user. Removes the session ID from the database.
  32
  33     :param username: the username which should be logged out
  34     :status 200: if the client didn't send a cookie, or the user was
  35                  successfully logged out
  36     :status 400: if the client provides a cookie, but for a different username than the one given