{ "info": { "author": "ACSONE SA/NV,Odoo Community Association (OCA)", "author_email": "support@odoo-community.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Odoo", "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)", "Programming Language :: Python" ], "description": "============\nAuth Api Key\n============\n\n.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github\n :target: https://github.com/OCA/server-auth/tree/13.0/auth_api_key\n :alt: OCA/server-auth\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-auth-13-0/server-auth-13-0-auth_api_key\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png\n :target: https://runbot.odoo-community.org/runbot/251/13.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nAuthenticate http requests from an API key.\n\nAPI 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.\n\nTake 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.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nThe api key menu is available into Settings > Technical in debug mode.\nBy default, when you create an API key, the key is saved into the database.\nIt is also possible to provide the value of this key via the configuration\nfile. This can be very useful to avoid mixing your keys between your various\nenvironments when restoring databases. All you have to do is to add a new\nsection to your configuration file according to the following convention:\n\n.. code-block:: ini\n\n [api_key_]\n key=my_api_key\n\nUsage\n=====\n\nTo apply this authentication system to your http request you must set 'api_key'\nas value for the 'auth' parameter of your route definition into your controller.\n\n.. code-block:: python\n\n class MyController(Controller):\n\n @route('/my_service', auth='api_key', ...)\n def my_service(self, *args, **kwargs):\n pass\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues `_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed\n`feedback `_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* ACSONE SA/NV\n\nContributors\n~~~~~~~~~~~~\n\n* Denis Robinet \n* Laurent Mignon \n* Quentin Groulard \n* S\u00e9bastien Beau \n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/server-auth `_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/OCA/server-auth", "keywords": "", "license": "LGPL-3", "maintainer": "", "maintainer_email": "", "name": "odoo13-addon-auth-api-key", "package_url": "https://pypi.org/project/odoo13-addon-auth-api-key/", "platform": "", "project_url": "https://pypi.org/project/odoo13-addon-auth-api-key/", "project_urls": { "Homepage": "https://github.com/OCA/server-auth" }, "release_url": "https://pypi.org/project/odoo13-addon-auth-api-key/13.0.1.0.1.dev4/", "requires_dist": [ "odoo13-addon-server-environment", "odoo (<13.1dev,>=13.0a)" ], "requires_python": ">=3.5", "summary": "Authenticate http requests from an API key", "version": "13.0.1.0.1.dev4", "yanked": false, "yanked_reason": null }, "last_serial": 10125414, "releases": { "13.0.1.0.1.dev2": [ { "comment_text": "", "digests": { "md5": "b6c3f755e9e3a5dcf3e7d9f201c8937c", "sha256": "fa340951bc09e4416c4dc86b61b0728f6edc07cc76cc611cbfa3b113833a3568" }, "downloads": -1, "filename": "odoo13_addon_auth_api_key-13.0.1.0.1.dev2-py3-none-any.whl", "has_sig": false, "md5_digest": "b6c3f755e9e3a5dcf3e7d9f201c8937c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 28357, "upload_time": "2019-10-31T05:59:21", "upload_time_iso_8601": "2019-10-31T05:59:21.326940Z", "url": "https://files.pythonhosted.org/packages/2d/12/b09fea310835d13c1c53abb896fb493d9eb3addf2836472d11106a6375a4/odoo13_addon_auth_api_key-13.0.1.0.1.dev2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.1.dev3": [ { "comment_text": "", "digests": { "md5": "162ab176bc80ed49ba956a8625a1b896", "sha256": "6585c085dd8ffbb93f744ff5a4dab696b5be758c6efa9fa6b04634b1a8b9bdf6" }, "downloads": -1, "filename": "odoo13_addon_auth_api_key-13.0.1.0.1.dev3-py3-none-any.whl", "has_sig": false, "md5_digest": "162ab176bc80ed49ba956a8625a1b896", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 28345, "upload_time": "2020-03-15T06:06:56", "upload_time_iso_8601": "2020-03-15T06:06:56.317635Z", "url": "https://files.pythonhosted.org/packages/aa/4b/14f7029639639e1daefbf8311deabd31f53758f8515b81c265c470418bd9/odoo13_addon_auth_api_key-13.0.1.0.1.dev3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.1.dev4": [ { "comment_text": "", "digests": { "md5": "578485d6dda0b000faf851804700cde2", "sha256": "6857bfcac34a8f89662810df42df6bd6a25ab8eb446ba22bad1a3b1e80fc652a" }, "downloads": -1, "filename": "odoo13_addon_auth_api_key-13.0.1.0.1.dev4-py3-none-any.whl", "has_sig": false, "md5_digest": "578485d6dda0b000faf851804700cde2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 28357, "upload_time": "2021-04-21T05:19:41", "upload_time_iso_8601": "2021-04-21T05:19:41.745368Z", "url": "https://files.pythonhosted.org/packages/42/ac/7ba0c191302eca538750dd4a72e3cb5f3fbff5710d9cf2c92dfc305110f6/odoo13_addon_auth_api_key-13.0.1.0.1.dev4-py3-none-any.whl", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "578485d6dda0b000faf851804700cde2", "sha256": "6857bfcac34a8f89662810df42df6bd6a25ab8eb446ba22bad1a3b1e80fc652a" }, "downloads": -1, "filename": "odoo13_addon_auth_api_key-13.0.1.0.1.dev4-py3-none-any.whl", "has_sig": false, "md5_digest": "578485d6dda0b000faf851804700cde2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 28357, "upload_time": "2021-04-21T05:19:41", "upload_time_iso_8601": "2021-04-21T05:19:41.745368Z", "url": "https://files.pythonhosted.org/packages/42/ac/7ba0c191302eca538750dd4a72e3cb5f3fbff5710d9cf2c92dfc305110f6/odoo13_addon_auth_api_key-13.0.1.0.1.dev4-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }