Skip to content

Commit 052c188

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 18ac8c0 commit 052c188

File tree

4 files changed

+82
-0
lines changed

4 files changed

+82
-0
lines changed

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70355,6 +70355,32 @@ endif::add-copy-button-to-env-var[]
7035570355
a|list of `cache`, `client-hints`, `cookies`, `execution-contexts`, `storage`, `wildcard`
7035670356
|
7035770357

70358+
a| [[quarkus-oidc_quarkus-oidc-logout-logout-mode]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-logout-mode[`quarkus.oidc.logout.logout-mode`]##
70359+
ifdef::add-copy-button-to-config-props[]
70360+
config_property_copy_button:+++quarkus.oidc.logout.logout-mode+++[]
70361+
endif::add-copy-button-to-config-props[]
70362+
70363+
70364+
`quarkus.oidc."tenant".logout.logout-mode`
70365+
ifdef::add-copy-button-to-config-props[]
70366+
config_property_copy_button:+++quarkus.oidc."tenant".logout.logout-mode+++[]
70367+
endif::add-copy-button-to-config-props[]
70368+
70369+
[.description]
70370+
--
70371+
Logout mode
70372+
70373+
70374+
ifdef::add-copy-button-to-env-var[]
70375+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++[]
70376+
endif::add-copy-button-to-env-var[]
70377+
ifndef::add-copy-button-to-env-var[]
70378+
Environment variable: `+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++`
70379+
endif::add-copy-button-to-env-var[]
70380+
--
70381+
a|tooltip:query[Logout parameters are encoded in the query string], tooltip:form-post[Logout parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
70382+
|tooltip:query[Logout parameters are encoded in the query string]
70383+
7035870384

7035970385
h|[[quarkus-oidc_section_quarkus-oidc-certificate-chain]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-oidc-certificate-chain[Configuration of the certificate chain which can be used to verify tokens]##
7036070386
h|Type

‎_generated-doc/main/config/quarkus-oidc.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2778,6 +2778,32 @@ endif::add-copy-button-to-env-var[]
27782778
a|list of `cache`, `client-hints`, `cookies`, `execution-contexts`, `storage`, `wildcard`
27792779
|
27802780

2781+
a| [[quarkus-oidc_quarkus-oidc-logout-logout-mode]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-logout-mode[`quarkus.oidc.logout.logout-mode`]##
2782+
ifdef::add-copy-button-to-config-props[]
2783+
config_property_copy_button:+++quarkus.oidc.logout.logout-mode+++[]
2784+
endif::add-copy-button-to-config-props[]
2785+
2786+
2787+
`quarkus.oidc."tenant".logout.logout-mode`
2788+
ifdef::add-copy-button-to-config-props[]
2789+
config_property_copy_button:+++quarkus.oidc."tenant".logout.logout-mode+++[]
2790+
endif::add-copy-button-to-config-props[]
2791+
2792+
[.description]
2793+
--
2794+
Logout mode
2795+
2796+
2797+
ifdef::add-copy-button-to-env-var[]
2798+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++[]
2799+
endif::add-copy-button-to-env-var[]
2800+
ifndef::add-copy-button-to-env-var[]
2801+
Environment variable: `+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++`
2802+
endif::add-copy-button-to-env-var[]
2803+
--
2804+
a|tooltip:query[Logout parameters are encoded in the query string], tooltip:form-post[Logout parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
2805+
|tooltip:query[Logout parameters are encoded in the query string]
2806+
27812807

27822808
h|[[quarkus-oidc_section_quarkus-oidc-certificate-chain]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-oidc-certificate-chain[Configuration of the certificate chain which can be used to verify tokens]##
27832809
h|Type

‎_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2778,6 +2778,32 @@ endif::add-copy-button-to-env-var[]
27782778
a|list of `cache`, `client-hints`, `cookies`, `execution-contexts`, `storage`, `wildcard`
27792779
|
27802780

2781+
a| [[quarkus-oidc_quarkus-oidc-logout-logout-mode]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-logout-logout-mode[`quarkus.oidc.logout.logout-mode`]##
2782+
ifdef::add-copy-button-to-config-props[]
2783+
config_property_copy_button:+++quarkus.oidc.logout.logout-mode+++[]
2784+
endif::add-copy-button-to-config-props[]
2785+
2786+
2787+
`quarkus.oidc."tenant".logout.logout-mode`
2788+
ifdef::add-copy-button-to-config-props[]
2789+
config_property_copy_button:+++quarkus.oidc."tenant".logout.logout-mode+++[]
2790+
endif::add-copy-button-to-config-props[]
2791+
2792+
[.description]
2793+
--
2794+
Logout mode
2795+
2796+
2797+
ifdef::add-copy-button-to-env-var[]
2798+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++[]
2799+
endif::add-copy-button-to-env-var[]
2800+
ifndef::add-copy-button-to-env-var[]
2801+
Environment variable: `+++QUARKUS_OIDC_LOGOUT_LOGOUT_MODE+++`
2802+
endif::add-copy-button-to-env-var[]
2803+
--
2804+
a|tooltip:query[Logout parameters are encoded in the query string], tooltip:form-post[Logout parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
2805+
|tooltip:query[Logout parameters are encoded in the query string]
2806+
27812807

27822808
h|[[quarkus-oidc_section_quarkus-oidc-certificate-chain]] [.section-name.section-level0]##link:#quarkus-oidc_section_quarkus-oidc-certificate-chain[Configuration of the certificate chain which can be used to verify tokens]##
27832809
h|Type

‎_versions/main/guides/security-oidc-expanded-configuration.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -643,6 +643,7 @@ Quarkus OIDC supports three standard OIDC logout options: <<rp-initiated-logout>
643643
|quarkus.oidc.logout.post-logout-path || Post logout path
644644
|quarkus.oidc.logout.post-logout-uri-param || Post logout uri param
645645
|quarkus.oidc.logout.extra-params || Logout extra params
646+
|quarkus.oidc.logout.logout-mode |query| Logout mode
646647
|====
647648

648649
`quarkus.oidc.logout.path` is a relative path where a user logout request should be sent to. For example, given `quarkus.oidc.logout.path=/logout`, a `Logout` link in the SPA page can point to `http://localhost:8080/logout`. This path can be virtual, you do not have to create a JAX-RS endpoint or route handler listening on `/logout`. But for the `quarkus.oidc.logout.path` be effective, it must be secured, see the https://quarkus.io/guides/security-oidc-code-flow-authentication#user-initiated-logout[User-initiated logout] section for more details.
@@ -653,6 +654,9 @@ For the post logout redirect to work, OIDC providers usually require registering
653654

654655
`quarkus.oidc.logout.post-logout-uri-param` and `quarkus.oidc.logout.extra-params` can be used to customize the RP-initiated logout query parameters, for example, Auth0 might expect Auth0-specific logout query parameters, see the https://quarkus.io/guides/security-oidc-code-flow-authentication#user-initiated-logout[User-initiated logout] section for more details.
655656

657+
By default, all the logout parameters are serialized as logout URL query parameters.
658+
Some OIDC providers may require that logout parameters are encoded as HTML form values and auto-submitted in the browser with the HTTP POST method and the `application/x-www-form-urlencoded` content type: set `quarkus.oidc.logout.logout-mode=form-post` in this case.
659+
656660
[[back-channel-logout]]
657661
=== Back-channel Logout
658662

0 commit comments

Comments
 (0)