Skip to content

Commit 90cf9bc

Browse files
committed
[BOT] post-merge updates
1 parent 0abeb0f commit 90cf9bc

4 files changed

Lines changed: 85 additions & 75 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ addon | version | maintainers | summary
3333
[auth_oauth_filter_by_domain](auth_oauth_filter_by_domain/) | 16.0.1.0.0 | <a href='https://github.com/natuan9'><img src='https://github.com/natuan9.png' width='32' height='32' style='border-radius:50%;' alt='natuan9'/></a> | Filter OAuth providers by domain
3434
[auth_oauth_multi_token](auth_oauth_multi_token/) | 16.0.1.0.0 | | Allow multiple connection with the same OAuth account
3535
[auth_oauth_ropc](auth_oauth_ropc/) | 16.0.1.0.0 | | Allow to login with OAuth Resource Owner Password Credentials Grant
36-
[auth_oidc](auth_oidc/) | 16.0.1.2.2 | <a href='https://github.com/sbidoul'><img src='https://github.com/sbidoul.png' width='32' height='32' style='border-radius:50%;' alt='sbidoul'/></a> | Allow users to login through OpenID Connect Provider
36+
[auth_oidc](auth_oidc/) | 16.0.1.3.0 | <a href='https://github.com/sbidoul'><img src='https://github.com/sbidoul.png' width='32' height='32' style='border-radius:50%;' alt='sbidoul'/></a> | Allow users to login through OpenID Connect Provider
3737
[auth_oidc_environment](auth_oidc_environment/) | 16.0.1.0.0 | | This module allows to use server env for OIDC configuration
3838
[auth_saml](auth_saml/) | 16.0.1.2.1 | <a href='https://github.com/vincent-hatakeyama'><img src='https://github.com/vincent-hatakeyama.png' width='32' height='32' style='border-radius:50%;' alt='vincent-hatakeyama'/></a> | SAML2 Authentication
3939
[auth_session_timeout](auth_session_timeout/) | 16.0.1.0.0 | | This module disable all inactive sessions since a given delay

auth_oidc/README.rst

Lines changed: 52 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
15
=============================
26
Authentication OpenID Connect
37
=============================
@@ -7,13 +11,13 @@ Authentication OpenID Connect
711
!! This file is generated by oca-gen-addon-readme !!
812
!! changes will be overwritten. !!
913
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:f94abf0fc8ee2d5c9fde9f36b0b3ece7a612d0e4338f01a71b5e8fc0d1be0f72
14+
!! source digest: sha256:c6615e01f66a09fe805489ba68fbea863cf35a6b1e8293c83c185a79ebe762bb
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
1418
:target: https://odoo-community.org/page/development-status
1519
:alt: Beta
16-
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
20+
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
1721
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
1822
:alt: License: AGPL-3
1923
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--auth-lightgray.png?logo=github
@@ -75,23 +79,23 @@ Single tenant provider limits the access to user of your tenant, while
7579
Multitenants allow access for all AzureAD users, so user of foreign
7680
companies can use their AzureAD login without an guest account.
7781

78-
- Provider Name: Azure AD Single Tenant
79-
- Client ID: Application (client) id
80-
- Client Secret: Client secret
81-
- Allowed: yes
82-
- replace {tenant_id} in urls with your Azure tenant id
82+
- Provider Name: Azure AD Single Tenant
83+
- Client ID: Application (client) id
84+
- Client Secret: Client secret
85+
- Allowed: yes
86+
- replace {tenant_id} in urls with your Azure tenant id
8387

8488
or
8589

86-
- Provider Name: Azure AD Multitenant
87-
- Client ID: Application (client) id
88-
- Client Secret: Client secret
89-
- Allowed: yes
90+
- Provider Name: Azure AD Multitenant
91+
- Client ID: Application (client) id
92+
- Client Secret: Client secret
93+
- Allowed: yes
9094

9195
|image2|
9296

93-
- Auth Link Params: Add {'prompt':'select_account'} to the auth link to
94-
get the account selection screen |image3|
97+
- Auth Link Params: Add {'prompt':'select_account'} to the auth link to
98+
get the account selection screen |image3|
9599

96100
Setup for Keycloak
97101
------------------
@@ -109,25 +113,25 @@ In Keycloak:
109113

110114
In Odoo, create a new Oauth Provider with the following parameters:
111115

112-
- Provider name: Keycloak (or any name you like that identify your
113-
keycloak provider)
114-
- Auth Flow: OpenID Connect (authorization code flow)
115-
- Token Map : many options are possible like
116-
``preferred_username:user_id`` or ``email:user_id`` . This can be
117-
combined
118-
- Client ID: the same Client ID you entered when configuring the client
119-
in Keycloak
120-
- Client Secret: found in keycloak on the client Credentials tab
121-
- Allowed: yes
122-
- Body: the link text to appear on the login page, such as Login with
123-
Keycloak
124-
- Scope: openid email
125-
- Authentication URL: The "authorization_endpoint" URL found in the
126-
OpenID Endpoint Configuration of your Keycloak realm
127-
- Token URL: The "token_endpoint" URL found in the OpenID Endpoint
128-
Configuration of your Keycloak realm
129-
- JWKS URL: The "jwks_uri" URL found in the OpenID Endpoint
130-
Configuration of your Keycloak realm
116+
- Provider name: Keycloak (or any name you like that identify your
117+
keycloak provider)
118+
- Auth Flow: OpenID Connect (authorization code flow)
119+
- Token Map : many options are possible like
120+
``preferred_username:user_id`` or ``email:user_id`` . This can be
121+
combined
122+
- Client ID: the same Client ID you entered when configuring the client
123+
in Keycloak
124+
- Client Secret: found in keycloak on the client Credentials tab
125+
- Allowed: yes
126+
- Body: the link text to appear on the login page, such as Login with
127+
Keycloak
128+
- Scope: openid email
129+
- Authentication URL: The "authorization_endpoint" URL found in the
130+
OpenID Endpoint Configuration of your Keycloak realm
131+
- Token URL: The "token_endpoint" URL found in the OpenID Endpoint
132+
Configuration of your Keycloak realm
133+
- JWKS URL: The "jwks_uri" URL found in the OpenID Endpoint
134+
Configuration of your Keycloak realm
131135

132136
.. |image| image:: https://raw.githubusercontent.com/OCA/server-auth/16.0/auth_oidc/static/description/oauth-microsoft_azure-api_permissions.png
133137
.. |image1| image:: https://raw.githubusercontent.com/OCA/server-auth/16.0/auth_oidc/static/description/oauth-microsoft_azure-optional_claims.png
@@ -142,53 +146,53 @@ On the login page, click on the authentication provider you configured.
142146
Known issues / Roadmap
143147
======================
144148

145-
- When going to the login screen, check for a existing token and do a
146-
direct login without the clicking on the SSO link
147-
- When doing a logout an extra option to also logout at the SSO
148-
provider.
149+
- When going to the login screen, check for a existing token and do a
150+
direct login without the clicking on the SSO link
151+
- When doing a logout an extra option to also logout at the SSO
152+
provider.
149153

150154
Changelog
151155
=========
152156

153157
16.0.1.1.0 2024-02-28
154158
---------------------
155159

156-
- Forward port OpenID Connect fixes from 15.0 to 16.0
160+
- Forward port OpenID Connect fixes from 15.0 to 16.0
157161

158162
16.0.1.0.2 2023-11-16
159163
---------------------
160164

161-
- Readme link updates
165+
- Readme link updates
162166

163167
16.0.1.0.1 2023-10-09
164168
---------------------
165169

166-
- Add AzureAD code flow provider
170+
- Add AzureAD code flow provider
167171

168172
16.0.1.0.0 2023-01-27
169173
---------------------
170174

171-
- Odoo 16 migration
175+
- Odoo 16 migration
172176

173177
15.0.1.0.0 2023-01-06
174178
---------------------
175179

176-
- Odoo 15 migration
180+
- Odoo 15 migration
177181

178182
14.0.1.0.0 2021-12-10
179183
---------------------
180184

181-
- Odoo 14 migration
185+
- Odoo 14 migration
182186

183187
13.0.1.0.0 2020-04-10
184188
---------------------
185189

186-
- Odoo 13 migration, add authorization code flow.
190+
- Odoo 13 migration, add authorization code flow.
187191

188192
10.0.1.0.0 2018-10-05
189193
---------------------
190194

191-
- Initial implementation
195+
- Initial implementation
192196

193197
Bug Tracker
194198
===========
@@ -213,10 +217,10 @@ Authors
213217
Contributors
214218
------------
215219

216-
- Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
217-
- Stéphane Bidoul <stephane.bidoul@acsone.eu>
218-
- David Jaen <david.jaen.revert@gmail.com>
219-
- Andreas Perhab <andreas.perhab@wt-io-it.at>
220+
- Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
221+
- Stéphane Bidoul <stephane.bidoul@acsone.eu>
222+
- David Jaen <david.jaen.revert@gmail.com>
223+
- Andreas Perhab <andreas.perhab@wt-io-it.at>
220224

221225
Maintainers
222226
-----------

auth_oidc/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
{
66
"name": "Authentication OpenID Connect",
7-
"version": "16.0.1.2.2",
7+
"version": "16.0.1.3.0",
88
"license": "AGPL-3",
99
"author": (
1010
"ICTSTUDIO, André Schenkels, "

auth_oidc/static/description/index.html

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
55
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
6-
<title>Authentication OpenID Connect</title>
6+
<title>README.rst</title>
77
<style type="text/css">
88

99
/*
@@ -360,16 +360,21 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document" id="authentication-openid-connect">
364-
<h1 class="title">Authentication OpenID Connect</h1>
363+
<div class="document">
365364

365+
366+
<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
367+
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
368+
</a>
369+
<div class="section" id="authentication-openid-connect">
370+
<h1>Authentication OpenID Connect</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:f94abf0fc8ee2d5c9fde9f36b0b3ece7a612d0e4338f01a71b5e8fc0d1be0f72
375+
!! source digest: sha256:c6615e01f66a09fe805489ba68fbea863cf35a6b1e8293c83c185a79ebe762bb
371376
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372-
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/16.0/auth_oidc"><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-16-0/server-auth-16-0-auth_oidc"><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=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
377+
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-auth/tree/16.0/auth_oidc"><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-16-0/server-auth-16-0-auth_oidc"><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=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
373378
<p>This module allows users to login through an OpenID Connect provider
374379
using the authorization code flow or implicit flow.</p>
375380
<p>Note the implicit flow is not recommended because it exposes access
@@ -406,15 +411,15 @@ <h1 class="title">Authentication OpenID Connect</h1>
406411
</ul>
407412
</div>
408413
<div class="section" id="installation">
409-
<h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
414+
<h2><a class="toc-backref" href="#toc-entry-1">Installation</a></h2>
410415
<p>This module depends on the
411416
<a class="reference external" href="https://pypi.org/project/python-jose/">python-jose</a> library, not to
412417
be confused with <tt class="docutils literal">jose</tt> which is also available on PyPI.</p>
413418
</div>
414419
<div class="section" id="configuration">
415-
<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
420+
<h2><a class="toc-backref" href="#toc-entry-2">Configuration</a></h2>
416421
<div class="section" id="setup-for-microsoft-azure">
417-
<h2><a class="toc-backref" href="#toc-entry-3">Setup for Microsoft Azure</a></h2>
422+
<h3><a class="toc-backref" href="#toc-entry-3">Setup for Microsoft Azure</a></h3>
418423
<p>Example configuration with OpenID Connect authorization code flow.</p>
419424
<ol class="arabic simple">
420425
<li>configure a new web application in Azure with OpenID and code flow
@@ -454,7 +459,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Setup for Microsoft Azure</a></h2
454459
</ul>
455460
</div>
456461
<div class="section" id="setup-for-keycloak">
457-
<h2><a class="toc-backref" href="#toc-entry-4">Setup for Keycloak</a></h2>
462+
<h3><a class="toc-backref" href="#toc-entry-4">Setup for Keycloak</a></h3>
458463
<p>Example configuration with OpenID Connect authorization code flow.</p>
459464
<p>In Keycloak:</p>
460465
<ol class="arabic simple">
@@ -490,11 +495,11 @@ <h2><a class="toc-backref" href="#toc-entry-4">Setup for Keycloak</a></h2>
490495
</div>
491496
</div>
492497
<div class="section" id="usage">
493-
<h1><a class="toc-backref" href="#toc-entry-5">Usage</a></h1>
498+
<h2><a class="toc-backref" href="#toc-entry-5">Usage</a></h2>
494499
<p>On the login page, click on the authentication provider you configured.</p>
495500
</div>
496501
<div class="section" id="known-issues-roadmap">
497-
<h1><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h1>
502+
<h2><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h2>
498503
<ul class="simple">
499504
<li>When going to the login screen, check for a existing token and do a
500505
direct login without the clicking on the SSO link</li>
@@ -503,76 +508,76 @@ <h1><a class="toc-backref" href="#toc-entry-6">Known issues / Roadmap</a></h1>
503508
</ul>
504509
</div>
505510
<div class="section" id="changelog">
506-
<h1><a class="toc-backref" href="#toc-entry-7">Changelog</a></h1>
511+
<h2><a class="toc-backref" href="#toc-entry-7">Changelog</a></h2>
507512
<div class="section" id="section-1">
508-
<h2><a class="toc-backref" href="#toc-entry-8">16.0.1.1.0 2024-02-28</a></h2>
513+
<h3><a class="toc-backref" href="#toc-entry-8">16.0.1.1.0 2024-02-28</a></h3>
509514
<ul class="simple">
510515
<li>Forward port OpenID Connect fixes from 15.0 to 16.0</li>
511516
</ul>
512517
</div>
513518
<div class="section" id="section-2">
514-
<h2><a class="toc-backref" href="#toc-entry-9">16.0.1.0.2 2023-11-16</a></h2>
519+
<h3><a class="toc-backref" href="#toc-entry-9">16.0.1.0.2 2023-11-16</a></h3>
515520
<ul class="simple">
516521
<li>Readme link updates</li>
517522
</ul>
518523
</div>
519524
<div class="section" id="section-3">
520-
<h2><a class="toc-backref" href="#toc-entry-10">16.0.1.0.1 2023-10-09</a></h2>
525+
<h3><a class="toc-backref" href="#toc-entry-10">16.0.1.0.1 2023-10-09</a></h3>
521526
<ul class="simple">
522527
<li>Add AzureAD code flow provider</li>
523528
</ul>
524529
</div>
525530
<div class="section" id="section-4">
526-
<h2><a class="toc-backref" href="#toc-entry-11">16.0.1.0.0 2023-01-27</a></h2>
531+
<h3><a class="toc-backref" href="#toc-entry-11">16.0.1.0.0 2023-01-27</a></h3>
527532
<ul class="simple">
528533
<li>Odoo 16 migration</li>
529534
</ul>
530535
</div>
531536
<div class="section" id="section-5">
532-
<h2><a class="toc-backref" href="#toc-entry-12">15.0.1.0.0 2023-01-06</a></h2>
537+
<h3><a class="toc-backref" href="#toc-entry-12">15.0.1.0.0 2023-01-06</a></h3>
533538
<ul class="simple">
534539
<li>Odoo 15 migration</li>
535540
</ul>
536541
</div>
537542
<div class="section" id="section-6">
538-
<h2><a class="toc-backref" href="#toc-entry-13">14.0.1.0.0 2021-12-10</a></h2>
543+
<h3><a class="toc-backref" href="#toc-entry-13">14.0.1.0.0 2021-12-10</a></h3>
539544
<ul class="simple">
540545
<li>Odoo 14 migration</li>
541546
</ul>
542547
</div>
543548
<div class="section" id="section-7">
544-
<h2><a class="toc-backref" href="#toc-entry-14">13.0.1.0.0 2020-04-10</a></h2>
549+
<h3><a class="toc-backref" href="#toc-entry-14">13.0.1.0.0 2020-04-10</a></h3>
545550
<ul class="simple">
546551
<li>Odoo 13 migration, add authorization code flow.</li>
547552
</ul>
548553
</div>
549554
<div class="section" id="section-8">
550-
<h2><a class="toc-backref" href="#toc-entry-15">10.0.1.0.0 2018-10-05</a></h2>
555+
<h3><a class="toc-backref" href="#toc-entry-15">10.0.1.0.0 2018-10-05</a></h3>
551556
<ul class="simple">
552557
<li>Initial implementation</li>
553558
</ul>
554559
</div>
555560
</div>
556561
<div class="section" id="bug-tracker">
557-
<h1><a class="toc-backref" href="#toc-entry-16">Bug Tracker</a></h1>
562+
<h2><a class="toc-backref" href="#toc-entry-16">Bug Tracker</a></h2>
558563
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-auth/issues">GitHub Issues</a>.
559564
In case of trouble, please check there if your issue has already been reported.
560565
If you spotted it first, help us to smash it by providing a detailed and welcomed
561566
<a class="reference external" href="https://github.com/OCA/server-auth/issues/new?body=module:%20auth_oidc%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
562567
<p>Do not contact contributors directly about support or help with technical issues.</p>
563568
</div>
564569
<div class="section" id="credits">
565-
<h1><a class="toc-backref" href="#toc-entry-17">Credits</a></h1>
570+
<h2><a class="toc-backref" href="#toc-entry-17">Credits</a></h2>
566571
<div class="section" id="authors">
567-
<h2><a class="toc-backref" href="#toc-entry-18">Authors</a></h2>
572+
<h3><a class="toc-backref" href="#toc-entry-18">Authors</a></h3>
568573
<ul class="simple">
569574
<li>ICTSTUDIO</li>
570575
<li>André Schenkels</li>
571576
<li>ACSONE SA/NV</li>
572577
</ul>
573578
</div>
574579
<div class="section" id="contributors">
575-
<h2><a class="toc-backref" href="#toc-entry-19">Contributors</a></h2>
580+
<h3><a class="toc-backref" href="#toc-entry-19">Contributors</a></h3>
576581
<ul class="simple">
577582
<li>Alexandre Fayolle &lt;<a class="reference external" href="mailto:alexandre.fayolle&#64;camptocamp.com">alexandre.fayolle&#64;camptocamp.com</a>&gt;</li>
578583
<li>Stéphane Bidoul &lt;<a class="reference external" href="mailto:stephane.bidoul&#64;acsone.eu">stephane.bidoul&#64;acsone.eu</a>&gt;</li>
@@ -581,7 +586,7 @@ <h2><a class="toc-backref" href="#toc-entry-19">Contributors</a></h2>
581586
</ul>
582587
</div>
583588
<div class="section" id="maintainers">
584-
<h2><a class="toc-backref" href="#toc-entry-20">Maintainers</a></h2>
589+
<h3><a class="toc-backref" href="#toc-entry-20">Maintainers</a></h3>
585590
<p>This module is maintained by the OCA.</p>
586591
<a class="reference external image-reference" href="https://odoo-community.org">
587592
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
@@ -596,5 +601,6 @@ <h2><a class="toc-backref" href="#toc-entry-20">Maintainers</a></h2>
596601
</div>
597602
</div>
598603
</div>
604+
</div>
599605
</body>
600606
</html>

0 commit comments

Comments
 (0)