odoo14-addon-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 menu is available into Settings > Technical in debug mode. By default, when you create an API key, the key is saved into the database.

If you want to manage them via serve environment settings use auth_api_key_server_env.

Usage

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):
        pass

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 to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

ACSONE SA/NV

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>
Chafique Delli <chafique.delli@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.

Metadata

Release files for odoo14-addon-auth-api-key 14.0.3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo14-addon-auth-api-key 14.0.3.0.1
File	Interpreter	ABI	Platform	Actions Reset
odoo14_addon_auth_api_key-14.0.3.0.1-py3-none-any.whl 34.2 kB Sep 5, 2024 Without provenance	Python 3	none	any	Details for odoo14_addon_auth_api_key-14.0.3.0.1-py3-none-any.whl

Release files / odoo14_addon_auth_api_key-14.0.3.0.1-py3-none-any.whl

Download URL	odoo14_addon_auth_api_key-14.0.3.0.1-py3-none-any.whl
Size	34.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e18bbf32c019920473cc8977b71d9e4d5e951a470b6b639de18610166a81dc97`
BLAKE2b-256 checksum How to use checksums	`da40766fb47e90ce61cda29536ff5f5730c1cfb096c46c9e182d935a39c89874`
Upload date	Sep 5, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.3`

Security for odoo14-addon-auth-api-key 14.0.3.0.1

Report project as malware

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.