odoo-addon-auth-api-key 18.0.1.0.2

Authenticate http requests from an API key

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.

Odoo allows users to authenticate XMLRPC/JSONRPC calls using their API key instead of a password by native API keys (res.users.apikey). However, auth_api_key has some special features of its own such as:

• API keys remain usable even when the user is inactive, if enabled via settings (e.g., for system users in a shopinvader case).

• Supports dual authentication via Basic Auth and API_KEY in separate HTTP headers.

• Admins can manage API keys for all users

Given these advantages, particularly in use case like system user authentication, we have decided to keep the auth_api_key module

Table of contents

• Configuration

• Usage

• Bug Tracker

• Credits

  • Authors

  • Contributors

  • Other credits

  • Maintainers

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

Bug 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 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 <[e-mail]>

• Laurent Mignon <[e-mail]>

• Quentin Groulard <[e-mail]>

• Sébastien Beau <[e-mail]>

• Chafique Delli <[e-mail]>

• Thien Vo Hong <[e-mail]>

Other credits

The migration of this module from 17.0 to 18.0 was financially supported by Camptocamp.

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.