This section describes the REST-interface named: auth. There is a document about the REST interface in general: REST Server

REST Service: Auth

This section describes the REST-interface named: auth. This allows you to login, logout and get and check current user status and information.

Chech Authentication Status

A simple GET request tells you whether you are logged in and show user's information.

Request: 
GET /auth
Response: ok 1 1 gerd gERD Schaufelberger gerd@php-tools.net C 2009-01-16 19:58:42 2009-08-25 21:18:15 2009-08-25 21:18:15

Login

Request: 
POST /auth
gerd gerd123 Response: ok 1 1 gerd gERD Schaufelberger gerd@php-tools.net C 2009-01-16 19:58:42 2009-08-25 21:18:15 2009-08-25 21:18:15

The auth interface provides an alternative login method to HTTP basic authenditcation. Just send your credentials via HTTP POST.

Logout

Request: 
DELETE /auth
Response: ok 0

Use HTTP DELETE to logout current user.