From 26c9c33bc7ef002d5a2f08147c9dc59081374f20 Mon Sep 17 00:00:00 2001 From: Drew Short Date: Fri, 7 Sep 2018 22:47:23 -0500 Subject: [PATCH] Adding documentation about the note and expirationTime login options --- server/documentation/api/authentication.rst | 32 +++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/server/documentation/api/authentication.rst b/server/documentation/api/authentication.rst index 1b06c4b..ebd8efe 100644 --- a/server/documentation/api/authentication.rst +++ b/server/documentation/api/authentication.rst @@ -29,6 +29,38 @@ Authentication API "version": 0 } + **Example request with note and expirationTime** + + .. sourcecode:: http + + POST /auth/login HTTP/1.1 + Host: example.tld + Accept: application/json + Authorization: Basic + Content-Type: application/json + + { + "note": "Client API Access", + "expirationTime": "2019-07-29T23:59:59-05:00" + } + + **Example response**: + + .. sourcecode:: http + + HTTP/1.1 200 OK + Vary: Accept + Content-Type: application/json + + { + "note": "Client API Access", + "expirationTime": "2019-07-29T23:59:59-05:00", + "creationTime": "2018-07-29T11:59:29-05:00", + "enabled": true, + "token": "b94cf5c7-cddc-4610-9d4c-6b8e04088ae8", + "version": 0 + } + :
header Content-Type: Depends on :mailheader:`Accept` header of request