forked from OCA/server-auth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
7 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,4 @@ | ||
The api key menu is available into Settings > Technical in debug mode. | ||
By default, when you create an API key, the key is saved into the database. | ||
It is also possible to provide the value of this key via the configuration | ||
file. This can be very useful to avoid mixing your keys between your various | ||
environments when restoring databases. All you have to do is to add a new | ||
section to your configuration file according to the following convention: | ||
|
||
.. code-block:: ini | ||
[api_key_<Record Name>] | ||
key=my_api_key | ||
If you want to manage them via serve environment settings use `auth_api_key_server_env`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
Authenticate http requests from an API key. | ||
|
||
API keys are codes passed in (in the http header API-KEY) by programs calling an API in order to identify -in this case- the calling program's user. | ||
API keys are codes passed in (in the http header API-KEY) | ||
by programs calling an API in order to identify -in this case- the calling program's user. | ||
|
||
Take care while using this kind of mechanism since information into http headers are visible in clear. Thus, use it only to authenticate requests from known sources. For unknown sources, it is a good practice to filter out this header at proxy level. | ||
Take care while using this kind of mechanism since information into http headers are visible in clear. | ||
Thus, use it only to authenticate requests from known sources. | ||
|
||
For unknown sources, it is a good practice to filter out this header at proxy level. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters