Auth Api Key
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.
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.
Table of contents
Configuration
The api key must be provided by the configuration parameter named ‘api_key_*.key’, and the user under the same option ‘api_key_*.user’.
For instance :
[api_key_mykey]
key=my_api_key
user=my_userUsage
To apply this authentication system to your http request you must set ‘api_key’ as value for the ‘auth’ parameter of your route definition into your controller.
class MyController(Controller):
@route('/my_service', auth='api_key', ...)
def my_service(self, *args, **kwargs):
passBug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
Denis Robinet <denis.robinet@acsone.eu>
Laurent Mignon <laurent.mignon@acsone.eu>
Quentin Groulard <quentin.groulard@acsone.eu>
Sébastien Beau <sebastien.beau@akretion.com>
Maintainers
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.
This module is part of the OCA/server-auth project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 maintainer
Metadata
1 maintainer
Release files for odoo10-addon-auth-api-key 10.0.1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| odoo10_addon_auth_api_key-10.0.1.0.1-py2-none-any.whl | Python 2 | none | any | Details for odoo10_addon_auth_api_key-10.0.1.0.1-py2-none-any.whl |
Release files / odoo10_addon_auth_api_key-10.0.1.0.1-py2-none-any.whl
| Download URL | odoo10_addon_auth_api_key-10.0.1.0.1-py2-none-any.whl |
|---|---|
| Size | 16.2 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
c2292fa2d4032b971f9b454a4bc028b78fcc7a4fc5efb4d9f7774cc5a8894845
|
|
BLAKE2b-256 checksum How to use checksums |
3a33063a518a740b8d0b0bd621fdfe8c768b08b37f3398565558f22bd8794eaa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/30.4.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.3
|
Security for odoo10-addon-auth-api-key 10.0.1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
