Skip to content

Commit a162ae9

Browse files
committed
[BOT] post-merge updates
1 parent f11d355 commit a162ae9

File tree

4 files changed

+29
-4
lines changed

4 files changed

+29
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ addon | version | maintainers | summary
2323
--- | --- | --- | ---
2424
[auth_admin_passkey](auth_admin_passkey/) | 17.0.1.0.0 | | Allows system administrator to authenticate with any account
2525
[auth_admin_passkey_totp_mail_enforce](auth_admin_passkey_totp_mail_enforce/) | 17.0.1.0.0 | | Disable 2FA if Passkey is being used
26-
[auth_api_key](auth_api_key/) | 17.0.1.1.0 | | Authenticate http requests from an API key
26+
[auth_api_key](auth_api_key/) | 17.0.1.1.1 | | Authenticate http requests from an API key
2727
[auth_api_key_group](auth_api_key_group/) | 17.0.1.0.1 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Allow grouping API keys together. Grouping per se does nothing. This feature is supposed to be used by other modules to limit access to services or records based on groups of keys.
2828
[auth_api_key_server_env](auth_api_key_server_env/) | 17.0.1.0.0 | | Configure api keys via server env. 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:
2929
[auth_oidc](auth_oidc/) | 17.0.1.0.0 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | Allow users to login through OpenID Connect Provider

auth_api_key/README.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Auth Api Key
77
!! This file is generated by oca-gen-addon-readme !!
88
!! changes will be overwritten. !!
99
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:5baa940e682e7653045bd8939d27f501b2409da7a9b3ec1ca80597eb2b79e7b7
10+
!! source digest: sha256:ae78e8c4442001a4d138783fb1c46e4ad153932b5b8ca56333b08e21cdfbeaef
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
1313
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
@@ -41,6 +41,19 @@ from known sources.
4141
For unknown sources, it is a good practice to filter out this header at
4242
proxy level.
4343

44+
Odoo allows users to authenticate ``XMLRPC/JSONRPC`` calls using their
45+
API key instead of a password by native API keys (``res.users.apikey``).
46+
However, ``auth_api_key`` has some special features of its own such as:
47+
48+
- API keys remain usable even when the user is inactive, if enabled via
49+
settings (e.g., for system users in a shopinvader case).
50+
- Supports dual authentication via Basic Auth and API_KEY in separate
51+
HTTP headers.
52+
- Admins can manage API keys for all users
53+
54+
Given these advantages, particularly in use case like system user
55+
authentication, we have decided to keep the ``auth_api_key`` module
56+
4457
**Table of contents**
4558

4659
.. contents::

auth_api_key/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"name": "Auth Api Key",
66
"summary": """
77
Authenticate http requests from an API key""",
8-
"version": "17.0.1.1.0",
8+
"version": "17.0.1.1.1",
99
"license": "LGPL-3",
1010
"author": "ACSONE SA/NV,Odoo Community Association (OCA)",
1111
"website": "https://github.com/OCA/server-auth",

auth_api_key/static/description/index.html

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ <h1 class="title">Auth Api Key</h1>
367367
!! This file is generated by oca-gen-addon-readme !!
368368
!! changes will be overwritten. !!
369369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:5baa940e682e7653045bd8939d27f501b2409da7a9b3ec1ca80597eb2b79e7b7
370+
!! source digest: sha256:ae78e8c4442001a4d138783fb1c46e4ad153932b5b8ca56333b08e21cdfbeaef
371371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372372
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/17.0/auth_api_key"><img alt="OCA/server-auth" src="https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-auth-17-0/server-auth-17-0-auth_api_key"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-auth&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
373373
<p>Authenticate http requests from an API key.</p>
@@ -379,6 +379,18 @@ <h1 class="title">Auth Api Key</h1>
379379
from known sources.</p>
380380
<p>For unknown sources, it is a good practice to filter out this header at
381381
proxy level.</p>
382+
<p>Odoo allows users to authenticate <tt class="docutils literal">XMLRPC/JSONRPC</tt> calls using their
383+
API key instead of a password by native API keys (<tt class="docutils literal">res.users.apikey</tt>).
384+
However, <tt class="docutils literal">auth_api_key</tt> has some special features of its own such as:</p>
385+
<ul class="simple">
386+
<li>API keys remain usable even when the user is inactive, if enabled via
387+
settings (e.g., for system users in a shopinvader case).</li>
388+
<li>Supports dual authentication via Basic Auth and API_KEY in separate
389+
HTTP headers.</li>
390+
<li>Admins can manage API keys for all users</li>
391+
</ul>
392+
<p>Given these advantages, particularly in use case like system user
393+
authentication, we have decided to keep the <tt class="docutils literal">auth_api_key</tt> module</p>
382394
<p><strong>Table of contents</strong></p>
383395
<div class="contents local topic" id="contents">
384396
<ul class="simple">

0 commit comments

Comments
 (0)