parallelvirtualcluster/pvc
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases 114 Wiki Activity

Move token authentication to X-Api-Token header

Browse Source 
Implements #46
This commit is contained in:
Joshua Boniface
2019-07-28 23:12:53 -04:00
parent 717d00cfcf
commit 47c72d9b68
2 changed files with 28 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manuals/api.md
View File

@ -16,7 +16,7 @@ Authentication for the API is available using a static list of tokens. These tok
The API provides session-based login using the `/api/v1/auth/login` and `/api/v1/auth/logout` options. If authentication is not enabled, these endpoints return a JSON `message` of `Authentiation is disabled` and HTTP code 200.
For one-time authentication, the `token` value can be specified to any API endpoint. This is only checked if there is no valid session already established. If authentication is enabled, there is no valid session, and no `token` value is specified, the API will return a JSON `message` of `Authentication required` and HTTP code 401.
For one-time authentication, the `token` value can be specified to any API endpoint via the `X-Api-Key` header value. This is only checked if there is no valid session already established. If authentication is enabled, there is no valid session, and no `token` value is specified, the API will return a JSON `message` of `Authentication required` and HTTP code 401.
### Values
@ -107,7 +107,7 @@ The Flask authentication secret key used to salt session credentials. Should be
* *optional*
* *requires* `authentication` -> `enabled`
A list of API authentication tokens that can be passed via the `X-Authentication` header to authorize access to the API.
A list of API authentication tokens that can be passed via the `X-Api-Key` header to authorize access to the API.
##### `description`