Browse Source

Adding documentation about the note and expirationTime login options

framework
Drew Short 6 years ago
parent
commit
26c9c33bc7
  1. 32
      server/documentation/api/authentication.rst

32
server/documentation/api/authentication.rst

@ -29,6 +29,38 @@ Authentication API
"version": 0 "version": 0
} }
**Example request with note and expirationTime**
.. sourcecode:: http
POST /auth/login HTTP/1.1
Host: example.tld
Accept: application/json
Authorization: Basic <Base64 Encoded Basic Auth>
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 Accept: Response content type depends on :mailheader:`Accept` header :<header Accept: Response content type depends on :mailheader:`Accept` header
:<header Authorization: Encoded basic authorization :<header Authorization: Encoded basic authorization
:>header Content-Type: Depends on :mailheader:`Accept` header of request :>header Content-Type: Depends on :mailheader:`Accept` header of request

Loading…
Cancel
Save