vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-22 14:07:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

#246: CURL examples for API authentication

Browse Source
This commit is contained in:
Benjamin Gamard 2018-10-18 22:22:40 +02:00
parent 0c257b763d
commit 867c3207c5
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs-web/src/main/webapp/header.md
View File

@ -27,20 +27,23 @@ All dates are returned in UNIX timestamp format in milliseconds.
## Authentication ## Authentication
#### **Step 1: [POST /user/login](#api-User-PostUserLogin)** #### **Step 1: [POST /user/login](#api-User-PostUserLogin)**
A call to this endpoint will return a cookie header like this: A call to this endpoint will return a cookie header. Here is a CURL example:
``` ```
HTTP Response: curl -i -X POST -d username=admin -d password=admin https://docs.mycompany.com/api/user/login
Set-Cookie: auth_token=64085630-2ae6-415c-9a92-4b22c107eaa4 Set-Cookie: auth_token=64085630-2ae6-415c-9a92-4b22c107eaa4
``` ```
#### **Step 2: Authenticated API calls** #### **Step 2: Authenticated API calls**
All following API calls must have a cookie header supplying the given token, like this: All following API calls must have a cookie header supplying the given token. Here is a CURL example:
``` ```
HTTP Request: curl -i -X GET -H "Cookie: auth_token=64085630-2ae6-415c-9a92-4b22c107eaa4" https://docs.mycompany.com/api/document/list
Cookie: auth_token=64085630-2ae6-415c-9a92-4b22c107eaa4 {"total":12,"documents":[...]}
``` ```
#### **Step 3: [POST /user/logout](#api-User-PostUserLogout)** #### **Step 3: [POST /user/logout](#api-User-PostUserLogout)**
A call to this API with a given `auth_token` cookie will make it unusable for other calls. A call to this API with a given `auth_token` cookie will make it unusable for other calls.
```
curl -i -X POST -H "Cookie: auth_token=64085630-2ae6-415c-9a92-4b22c107eaa4" https://docs.mycompany.com/api/user/logout
```