Skip to content

Commit 182b219

Browse files
committed
Sync documentation of main branch
1 parent 32df526 commit 182b219

File tree

4 files changed

+82
-1
lines changed

4 files changed

+82
-1
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69934,6 +69934,32 @@ endif::add-copy-button-to-env-var[]
6993469934
|string
6993569935
|
6993669936

69937+
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server[`quarkus.oidc.resource-metadata.authorization-server`]##
69938+
ifdef::add-copy-button-to-config-props[]
69939+
config_property_copy_button:+++quarkus.oidc.resource-metadata.authorization-server+++[]
69940+
endif::add-copy-button-to-config-props[]
69941+
69942+
69943+
`quarkus.oidc."tenant".resource-metadata.authorization-server`
69944+
ifdef::add-copy-button-to-config-props[]
69945+
config_property_copy_button:+++quarkus.oidc."tenant".resource-metadata.authorization-server+++[]
69946+
endif::add-copy-button-to-config-props[]
69947+
69948+
[.description]
69949+
--
69950+
Authorization server URL. 'quarkus.oidc.auth-server-url' property value is reported by default.
69951+
69952+
69953+
ifdef::add-copy-button-to-env-var[]
69954+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++[]
69955+
endif::add-copy-button-to-env-var[]
69956+
ifndef::add-copy-button-to-env-var[]
69957+
Environment variable: `+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++`
69958+
endif::add-copy-button-to-env-var[]
69959+
--
69960+
|string
69961+
|
69962+
6993769963
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme[`quarkus.oidc.resource-metadata.force-https-scheme`]##
6993869964
ifdef::add-copy-button-to-config-props[]
6993969965
config_property_copy_button:+++quarkus.oidc.resource-metadata.force-https-scheme+++[]

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1913,6 +1913,32 @@ endif::add-copy-button-to-env-var[]
19131913
|string
19141914
|
19151915

1916+
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server[`quarkus.oidc.resource-metadata.authorization-server`]##
1917+
ifdef::add-copy-button-to-config-props[]
1918+
config_property_copy_button:+++quarkus.oidc.resource-metadata.authorization-server+++[]
1919+
endif::add-copy-button-to-config-props[]
1920+
1921+
1922+
`quarkus.oidc."tenant".resource-metadata.authorization-server`
1923+
ifdef::add-copy-button-to-config-props[]
1924+
config_property_copy_button:+++quarkus.oidc."tenant".resource-metadata.authorization-server+++[]
1925+
endif::add-copy-button-to-config-props[]
1926+
1927+
[.description]
1928+
--
1929+
Authorization server URL. 'quarkus.oidc.auth-server-url' property value is reported by default.
1930+
1931+
1932+
ifdef::add-copy-button-to-env-var[]
1933+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++[]
1934+
endif::add-copy-button-to-env-var[]
1935+
ifndef::add-copy-button-to-env-var[]
1936+
Environment variable: `+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++`
1937+
endif::add-copy-button-to-env-var[]
1938+
--
1939+
|string
1940+
|
1941+
19161942
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme[`quarkus.oidc.resource-metadata.force-https-scheme`]##
19171943
ifdef::add-copy-button-to-config-props[]
19181944
config_property_copy_button:+++quarkus.oidc.resource-metadata.force-https-scheme+++[]

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1913,6 +1913,32 @@ endif::add-copy-button-to-env-var[]
19131913
|string
19141914
|
19151915

1916+
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-authorization-server[`quarkus.oidc.resource-metadata.authorization-server`]##
1917+
ifdef::add-copy-button-to-config-props[]
1918+
config_property_copy_button:+++quarkus.oidc.resource-metadata.authorization-server+++[]
1919+
endif::add-copy-button-to-config-props[]
1920+
1921+
1922+
`quarkus.oidc."tenant".resource-metadata.authorization-server`
1923+
ifdef::add-copy-button-to-config-props[]
1924+
config_property_copy_button:+++quarkus.oidc."tenant".resource-metadata.authorization-server+++[]
1925+
endif::add-copy-button-to-config-props[]
1926+
1927+
[.description]
1928+
--
1929+
Authorization server URL. 'quarkus.oidc.auth-server-url' property value is reported by default.
1930+
1931+
1932+
ifdef::add-copy-button-to-env-var[]
1933+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++[]
1934+
endif::add-copy-button-to-env-var[]
1935+
ifndef::add-copy-button-to-env-var[]
1936+
Environment variable: `+++QUARKUS_OIDC_RESOURCE_METADATA_AUTHORIZATION_SERVER+++`
1937+
endif::add-copy-button-to-env-var[]
1938+
--
1939+
|string
1940+
|
1941+
19161942
a| [[quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-resource-metadata-force-https-scheme[`quarkus.oidc.resource-metadata.force-https-scheme`]##
19171943
ifdef::add-copy-button-to-config-props[]
19181944
config_property_copy_button:+++quarkus.oidc.resource-metadata.force-https-scheme+++[]

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,6 +1295,7 @@ In turn, a client that requested the protected resource metadata can use its pro
12951295

12961296
|quarkus.oidc.resource-metadata.enabled |false|Enable resource metadata properties
12971297
|quarkus.oidc.resource-metadata.resource ||Resource identifier
1298+
|quarkus.oidc.resource-metadata.authorization-server ||Authorization server URL
12981299
|quarkus.oidc.resource-metadata.force-https-scheme |true|Force that a resource identifier URL has an HTTPS scheme
12991300
|====
13001301

@@ -1307,7 +1308,9 @@ According to the https://datatracker.ietf.org/doc/rfc9728/[OAuth2 Protected Reso
13071308

13081309
If it is configured as a relative path then it is added to the current request URL's host and port to build a resource identifier URL. If it is not configured at all then, unless it is a default tenant id, the tenand id is added to the current request URL's host and port to build a resource identifier URL.
13091310

1310-
In such cases, the `quarkus.oidc.resource-metadata.force-https-scheme` property can be used to set a correct URL scheme, which is set to HTTPS by default.
1311+
The resource identifier URL scheme is set to `HTTPS` by default. You can enable an `HTTP` URL scheme with `quarkus.oidc.resource-metadata.force-https-scheme=false`, it can be particularly useful in simple demos and tests.
1312+
1313+
`quarkus.oidc.resource-metadata.authorization-server` allows to customize an authorization server URL that will be included in the resource metadata. The `quarkus.oidc.auth-server-url` URL is included by default, however, for some cases where an OIDC proxy interposes over the actual OIDC provider, returning the OIDC proxy's URL is required instead.
13111314

13121315
See also the <<oidc-metadata-properties>> for details about the OIDC provider metadata that Quarkus OIDC uses for its work.
13131316

0 commit comments

Comments
 (0)