From 25691ab3ba6c64d7d0ebcc014211f10d3fc0e3fa Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 15 Nov 2023 01:56:14 +0000 Subject: [PATCH] Sync documentation of main branch --- _data/versioned/main/index/quarkus.yaml | 11 - _data/versioned/main/index/relations.yaml | 83 --- ...agroal.runtime.DataSourceJdbcRuntimeConfig | 2 +- ...nfig.DataSourceJdbcOuterNamedRuntimeConfig | 2 +- .../io.quarkus.oidc.OidcTenantConfig | 2 +- .../io.quarkus.oidc.OidcTenantConfig.Jwks | 1 + ...ce.runtime.DataSourceReactiveRuntimeConfig | 2 +- ....DataSourceReactiveOuterNamedRuntimeConfig | 2 +- ...groal.runtime.DataSourcesJdbcRuntimeConfig | 2 +- ...arkus.jaeger.runtime.JaegerBuildTimeConfig | 1 - .../io.quarkus.jaeger.runtime.JaegerConfig | 1 - .../io.quarkus.jaeger.runtime.ZipkinConfig | 1 - ...godb.deployment.MongoClientBuildTimeConfig | 2 +- .../io.quarkus.oidc.runtime.OidcConfig | 2 +- ...e.runtime.DataSourcesReactiveRuntimeConfig | 2 +- ...smallrye.opentracing.runtime.TracingConfig | 1 - ...arkus.jaeger.runtime.JaegerBuildTimeConfig | 1 - .../io.quarkus.jaeger.runtime.JaegerConfig | 1 - .../io.quarkus.jaeger.runtime.ZipkinConfig | 1 - ...smallrye.opentracing.runtime.TracingConfig | 1 - ...group-data-source-jdbc-runtime-config.adoc | 16 +- ...ource-jdbc-outer-named-runtime-config.adoc | 8 +- .../quarkus-agroal-general-config-items.adoc | 16 +- .../main/config/quarkus-agroal.adoc | 16 +- .../main/config/quarkus-all-build-items.adoc | 6 + .../main/config/quarkus-all-config.adoc | 565 +++++------------- ...urce-data-sources-jdbc-runtime-config.adoc | 16 +- ...ta-sources-reactive-build-time-config.adoc | 2 +- ...-data-sources-reactive-runtime-config.adoc | 4 +- ...arkus-jaeger-jaeger-build-time-config.adoc | 46 -- .../config/quarkus-jaeger-jaeger-config.adoc | 323 ---------- .../quarkus-jaeger-zipkin-zipkin-config.adoc | 29 - .../main/config/quarkus-jaeger.adoc | 374 ------------ ...ongodb-mongo-client-build-time-config.adoc | 17 - .../main/config/quarkus-mongodb.adoc | 17 - .../quarkus-oidc-general-config-items.adoc | 144 +++++ .../main/config/quarkus-oidc-oidc-config.adoc | 144 +++++ .../quarkus-oidc-oidc-tenant-config-jwks.adoc | 175 ++++++ .../quarkus-oidc-oidc-tenant-config.adoc | 144 +++++ _generated-doc/main/config/quarkus-oidc.adoc | 144 +++++ .../quarkus-opentracing-tracing-config.adoc | 43 -- ...p-data-source-reactive-runtime-config.adoc | 4 +- ...eactive-outer-named-build-time-config.adoc | 2 +- ...e-reactive-outer-named-runtime-config.adoc | 2 +- ...ctive-datasource-general-config-items.adoc | 4 +- .../config/quarkus-reactive-datasource.adoc | 4 +- .../config/quarkus-smallrye-opentracing.adoc | 43 -- _versions/main/guides/datasource.adoc | 7 +- .../guides/infinispan-client-reference.adoc | 24 +- _versions/main/guides/infinispan-client.adoc | 12 +- _versions/main/guides/mongodb.adoc | 7 - _versions/main/guides/opentracing.adoc | 354 ----------- _versions/main/guides/reaugmentation.adoc | 2 +- ...idc-code-flow-authentication-tutorial.adoc | 5 +- .../security-proactive-authentication.adoc | 4 +- ...elemetry-opentracing-to-otel-tutorial.adoc | 2 +- 56 files changed, 1007 insertions(+), 1839 deletions(-) create mode 100644 _generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Jwks delete mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig delete mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerConfig delete mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.ZipkinConfig delete mode 100644 _generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.smallrye.opentracing.runtime.TracingConfig delete mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig delete mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerConfig delete mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.ZipkinConfig delete mode 100644 _generated-doc/main/config/extensions-configuration-roots-list/quarkus-smallrye-opentracing.adoc/io.quarkus.smallrye.opentracing.runtime.TracingConfig delete mode 100644 _generated-doc/main/config/quarkus-jaeger-jaeger-build-time-config.adoc delete mode 100644 _generated-doc/main/config/quarkus-jaeger-jaeger-config.adoc delete mode 100644 _generated-doc/main/config/quarkus-jaeger-zipkin-zipkin-config.adoc delete mode 100644 _generated-doc/main/config/quarkus-jaeger.adoc create mode 100644 _generated-doc/main/config/quarkus-oidc-oidc-tenant-config-jwks.adoc delete mode 100644 _generated-doc/main/config/quarkus-opentracing-tracing-config.adoc delete mode 100644 _generated-doc/main/config/quarkus-smallrye-opentracing.adoc delete mode 100644 _versions/main/guides/opentracing.adoc diff --git a/_data/versioned/main/index/quarkus.yaml b/_data/versioned/main/index/quarkus.yaml index 6e1acb20e88..0c85b12ba9b 100644 --- a/_data/versioned/main/index/quarkus.yaml +++ b/_data/versioned/main/index/quarkus.yaml @@ -2457,17 +2457,6 @@ types: - io.quarkus:quarkus-opentelemetry type: guide url: /guides/opentelemetry - - title: Using OpenTracing - filename: opentracing.adoc - summary: This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for interactive web applications. - categories: observability - topics: - - observability - - opentracing - extensions: - - io.quarkus:quarkus-smallrye-opentracing - type: guide - url: /guides/opentracing - title: Using Podman with Quarkus filename: podman.adoc summary: "Podman is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS." diff --git a/_data/versioned/main/index/relations.yaml b/_data/versioned/main/index/relations.yaml index 520821561f6..b64c8563103 100644 --- a/_data/versioned/main/index/relations.yaml +++ b/_data/versioned/main/index/relations.yaml @@ -1541,10 +1541,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 /guides/class-loading-reference: sameTopics: - title: "Duplicated context, context locals, asynchronous processing and propagation" @@ -8513,10 +8509,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 /guides/lra: sameTopics: - title: Using transactions in Quarkus @@ -8687,10 +8679,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 sameExtensions: - title: Authorization of web endpoints url: /guides/security-authorize-web-endpoints-reference @@ -9408,53 +9396,6 @@ url: /guides/smallrye-metrics type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 - sameExtensions: - - title: Migrate from OpenTracing to OpenTelemetry tracing - url: /guides/telemetry-opentracing-to-otel-tutorial - type: tutorial - matches: 1 -/guides/opentracing: - sameTopics: - - title: Migrate from OpenTracing to OpenTelemetry tracing - url: /guides/telemetry-opentracing-to-otel-tutorial - type: tutorial - matches: 2 - - title: "Centralized log management (Graylog, Logstash, Fluentd)" - url: /guides/centralized-log-management - type: guide - matches: 1 - - title: Collect metrics using Micrometer - url: /guides/telemetry-micrometer-tutorial - type: tutorial - matches: 1 - - title: Logging configuration - url: /guides/logging - type: reference - matches: 1 - - title: Management interface reference - url: /guides/management-interface-reference - type: reference - matches: 1 - - title: Micrometer Metrics - url: /guides/telemetry-micrometer - type: reference - matches: 1 - - title: SmallRye Health - url: /guides/smallrye-health - type: guide - matches: 1 - - title: SmallRye Metrics - url: /guides/smallrye-metrics - type: guide - matches: 1 - - title: Using OpenTelemetry - url: /guides/opentelemetry - type: guide - matches: 1 sameExtensions: - title: Migrate from OpenTracing to OpenTelemetry tracing url: /guides/telemetry-opentracing-to-otel-tutorial @@ -17240,10 +17181,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 /guides/smallrye-metrics: sameTopics: - title: "Centralized log management (Graylog, Logstash, Fluentd)" @@ -17278,10 +17215,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 /guides/software-transactional-memory: sameTopics: - title: Using transactions in Quarkus @@ -18353,10 +18286,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 sameExtensions: - title: Collect metrics using Micrometer url: /guides/telemetry-micrometer-tutorial @@ -18396,10 +18325,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 sameExtensions: - title: Micrometer Metrics url: /guides/telemetry-micrometer @@ -18411,10 +18336,6 @@ url: /guides/opentelemetry type: guide matches: 2 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 2 - title: "Centralized log management (Graylog, Logstash, Fluentd)" url: /guides/centralized-log-management type: guide @@ -18448,10 +18369,6 @@ url: /guides/opentelemetry type: guide matches: 1 - - title: Using OpenTracing - url: /guides/opentracing - type: guide - matches: 1 /guides/tests-with-coverage: sameTopics: - title: Continuous Testing diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig index 60bf31c61c0..29fe7a50313 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":".transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"BUILD_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":".transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"BUILD_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"`Map`","key":".additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tracing","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.agroal.runtime.DataSourceJdbcTracingRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.Boolean","key":".telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"This feature is disabled by default.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"By default, there is no restriction on the lifespan of a connection.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":".transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"BUILD_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":".transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"BUILD_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"`Map`","key":".additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tracing","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.agroal.runtime.DataSourceJdbcTracingRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"java.lang.Boolean","key":".tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"java.lang.Boolean","key":".telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig index 0f4321fede4..59c1ce26abc 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig @@ -1 +1 @@ -[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".jdbc","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":".jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"BUILD_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":".jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"BUILD_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"`Map`","key":".jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".jdbc","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.agroal.runtime.DataSourceJdbcRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"This feature is disabled by default.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"By default, there is no restriction on the lifespan of a connection.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":".jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"BUILD_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":".jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"BUILD_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"`Map`","key":".jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig index 85d6a486550..6e3f82f3b0a 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":".auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".credentials","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":".credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"BUILD_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Proxy","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":false,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":".tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"BUILD_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"path","key":".tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"path","key":".tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":".application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":false,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"BUILD_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".introspection-credentials","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.IntrospectionCredentials","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".roles","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Roles","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":".roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"BUILD_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".token","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Token","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":".token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"BUILD_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".logout","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Logout","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".authentication","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Authentication","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":".authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":false,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"BUILD_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":".authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":false,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".code-grant","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.CodeGrant","showSection":false,"configDocItems":[{"configDocKey":{"type":"`Map`","key":".code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".token-state-manager","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":".provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":".auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".credentials","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":".credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"BUILD_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".proxy","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Proxy","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":false,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".tls","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":".tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"BUILD_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"path","key":".tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"path","key":".tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"string","key":".tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":".application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":false,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"BUILD_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".introspection-credentials","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.IntrospectionCredentials","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".roles","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Roles","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":".roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"BUILD_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".token","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Token","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":".token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"BUILD_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".logout","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Logout","showSection":false,"configDocItems":[{"configDocKey":{"type":"string","key":".logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".authentication","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Authentication","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":".authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":false,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"BUILD_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"string","key":".authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":".authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":false,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"BUILD_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":".authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".code-grant","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.CodeGrant","showSection":false,"configDocItems":[{"configDocKey":{"type":"`Map`","key":".code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".token-state-manager","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager","showSection":false,"configDocItems":[{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":".token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"BUILD_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"boolean","key":".token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"boolean","key":".allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".jwks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.oidc.OidcTenantConfig.Jwks","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".jwks.resolve-early","additionalKeys":[],"configDoc":"If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.\n\nDisabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resolve-early","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".jwks.cache-size","additionalKeys":[],"configDoc":"Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jwks.cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".jwks.clean-up-timer-interval","additionalKeys":[],"configDoc":"Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":".provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"BUILD_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Jwks b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Jwks new file mode 100644 index 00000000000..d7c49e4ff63 --- /dev/null +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig.Jwks @@ -0,0 +1 @@ +[{"configDocKey":{"type":"boolean","key":".resolve-early","additionalKeys":[],"configDoc":"If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.\n\nDisabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resolve-early","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".cache-size","additionalKeys":[],"configDoc":"Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"cache-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-time-to-live","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".clean-up-timer-interval","additionalKeys":[],"configDoc":"Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig index 28c4629f31a..21529d2c4ee 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":".cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PemTrustCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-pfx","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PemKeyCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-pfx","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":".cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PemTrustCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".trust-certificate-pfx","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-pem","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PemKeyCertConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-jks","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.JksConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".key-certificate-pfx","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.vertx.core.runtime.config.PfxConfiguration","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":".reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig index 3bf2e2b3de6..d24b6737b0d 100644 --- a/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig @@ -1 +1 @@ -[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".reactive","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocSection":{"name":"","optional":false,"withinAMap":false,"sectionDetails":null,"sectionDetailsTitle":".reactive","configPhase":"BUILD_TIME","topLevelGrouping":"","configGroupType":"io.quarkus.reactive.datasource.runtime.DataSourceReactiveRuntimeConfig","showSection":false,"configDocItems":[{"configDocKey":{"type":"boolean","key":".reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"int","key":".reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":".reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map`","key":".reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig index 3c7a73d87f7..64ca8a35430 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":"quarkus.datasource.jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"RUN_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":"quarkus.datasource.jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"RUN_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocSection":{"name":"quarkus.datasource.named-data-sources","optional":false,"withinAMap":false,"sectionDetails":"= Additional named datasources","sectionDetailsTitle":"Additional named datasources","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.datasource","configGroupType":"io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.\"datasource-name\".jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":true,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":true,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":"quarkus.datasource.\"datasource-name\".jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"RUN_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":"quarkus.datasource.\"datasource-name\".jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"RUN_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.\"datasource-name\".jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":true,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":true,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":true,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":false,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":false,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":false,"defaultValue":"This feature is disabled by default.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":false,"defaultValue":"By default, there is no restriction on the lifespan of a connection.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":"quarkus.datasource.jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"RUN_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":"quarkus.datasource.jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"RUN_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":false,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocSection":{"name":"quarkus.datasource.named-data-sources","optional":false,"withinAMap":false,"sectionDetails":"= Additional named datasources","sectionDetailsTitle":"Additional named datasources","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.datasource","configGroupType":"io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.url","additionalKeys":[],"configDoc":"The datasource URL","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.\"datasource-name\".jdbc.initial-size","additionalKeys":[],"configDoc":"The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"initial-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".jdbc.min-size","additionalKeys":[],"configDoc":"The datasource pool minimum size","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"min-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".jdbc.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.background-validation-interval","additionalKeys":[],"configDoc":"The interval at which we validate idle connections in the background.\n\nSet to `0` to disable background validation.","withinAMap":true,"defaultValue":"2M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"background-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.foreground-validation-interval","additionalKeys":[],"configDoc":"Perform foreground validation on connections that have been idle for longer than the specified interval.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"foreground-validation-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.acquisition-timeout","additionalKeys":[],"configDoc":"The timeout before cancelling the acquisition of a new connection","withinAMap":true,"defaultValue":"5S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"acquisition-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.leak-detection-interval","additionalKeys":[],"configDoc":"The interval at which we check for connection leaks.","withinAMap":true,"defaultValue":"This feature is disabled by default.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"leak-detection-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.idle-removal-interval","additionalKeys":[],"configDoc":"The interval at which we try to remove idle connections.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-removal-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".jdbc.max-lifetime","additionalKeys":[],"configDoc":"The max lifetime of a connection.","withinAMap":true,"defaultValue":"By default, there is no restriction on the lifespan of a connection.","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionFactoryConfiguration.TransactionIsolation","key":"quarkus.datasource.\"datasource-name\".jdbc.transaction-isolation-level","additionalKeys":[],"configDoc":"The transaction isolation level.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionFactoryConfiguration.TransactionIsolation.html","docMapKey":"transaction-isolation-level","configPhase":"RUN_TIME","acceptedValues":["`undefined`","`none`","`read-uncommitted`","`read-committed`","`repeatable-read`","`serializable`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.extended-leak-report","additionalKeys":[],"configDoc":"Collect and display extra troubleshooting info on leaked connections.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"extended-leak-report","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.flush-on-close","additionalKeys":[],"configDoc":"Allows connections to be flushed upon return to the pool. It's not enabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"flush-on-close","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.detect-statement-leaks","additionalKeys":[],"configDoc":"When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"detect-statement-leaks","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.new-connection-sql","additionalKeys":[],"configDoc":"Query executed when first using a connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"new-connection-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.validation-query-sql","additionalKeys":[],"configDoc":"Query executed to validate a connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"validation-query-sql","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.pooling-enabled","additionalKeys":[],"configDoc":"Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"pooling-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"io.agroal.api.configuration.AgroalConnectionPoolConfiguration.TransactionRequirement","key":"quarkus.datasource.\"datasource-name\".jdbc.transaction-requirement","additionalKeys":[],"configDoc":"Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://jar-download.com/javaDoc/io.agroal/agroal-api/1.5/index.html?io/agroal/api/configuration/AgroalConnectionPoolConfiguration.TransactionRequirement.html","docMapKey":"transaction-requirement","configPhase":"RUN_TIME","acceptedValues":["`off`","`warn`","`strict`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":true}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.\"datasource-name\".jdbc.additional-jdbc-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed to the JDBC driver when creating new connections.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-jdbc-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.enabled","additionalKeys":[],"configDoc":"Enable JDBC tracing.","withinAMap":true,"defaultValue":"false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.trace-with-active-span-only","additionalKeys":[],"configDoc":"Trace calls with active Spans only","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trace-with-active-span-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".jdbc.tracing.ignore-for-tracing","additionalKeys":[],"configDoc":"Ignore specific queries from being traced","withinAMap":true,"defaultValue":"Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \\","javaDocSiteLink":"","docMapKey":"ignore-for-tracing","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.datasource.\"datasource-name\".jdbc.telemetry.enabled","additionalKeys":[],"configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":true,"defaultValue":"false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig deleted file mode 100644 index 3db8767ecdb..00000000000 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig +++ /dev/null @@ -1 +0,0 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.jaeger.enabled","additionalKeys":[],"configDoc":"Defines if the Jaeger extension is enabled.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jaeger.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published in case a metrics extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerConfig deleted file mode 100644 index 95087989a4f..00000000000 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.JaegerConfig +++ /dev/null @@ -1 +0,0 @@ -[{"configDocKey":{"type":"java.net.URI","key":"quarkus.jaeger.endpoint","additionalKeys":[],"configDoc":"The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html","docMapKey":"endpoint","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.auth-token","additionalKeys":[],"configDoc":"Authentication Token to send as \"Bearer\" to the endpoint","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.user","additionalKeys":[],"configDoc":"Username to send as part of \"Basic\" authentication to the endpoint","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.password","additionalKeys":[],"configDoc":"Password to send as part of \"Basic\" authentication to the endpoint","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"host:port","key":"quarkus.jaeger.agent-host-port","additionalKeys":[],"configDoc":"The hostname and port for communicating with agent via UDP","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"agent-host-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.jaeger.reporter-log-spans","additionalKeys":[],"configDoc":"Whether the reporter should also log the spans","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reporter-log-spans","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.jaeger.reporter-max-queue-size","additionalKeys":[],"configDoc":"The reporter's maximum queue size","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"reporter-max-queue-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.jaeger.reporter-flush-interval","additionalKeys":[],"configDoc":"The reporter's flush interval","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reporter-flush-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.sampler-type","additionalKeys":[],"configDoc":"The sampler type (const, probabilistic, ratelimiting or remote)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sampler-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.math.BigDecimal","key":"quarkus.jaeger.sampler-param","additionalKeys":[],"configDoc":"The sampler parameter (number)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html","docMapKey":"sampler-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"host:port","key":"quarkus.jaeger.sampler-manager-host-port","additionalKeys":[],"configDoc":"The host name and port when using the remote controlled sampler","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sampler-manager-host-port","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.service-name","additionalKeys":[],"configDoc":"The service name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.tags","additionalKeys":[],"configDoc":"A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format $++{++envVarName:default++}++, where the :default is optional, and identifies a value to be used if the environment variable cannot be found","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tags","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.propagation","additionalKeys":[],"configDoc":"Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"propagation","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jaeger.sender-factory","additionalKeys":[],"configDoc":"The sender factory class name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"sender-factory","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.jaeger.log-trace-context","additionalKeys":[],"configDoc":"Whether the trace context should be logged.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"log-trace-context","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.jaeger.disable-tracer-registration","additionalKeys":[],"configDoc":"Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"disable-tracer-registration","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.ZipkinConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.ZipkinConfig deleted file mode 100644 index cf135a38158..00000000000 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.jaeger.runtime.ZipkinConfig +++ /dev/null @@ -1 +0,0 @@ -[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.jaeger.zipkin.compatibility-mode","additionalKeys":[],"configDoc":"Whether jaeger should run in zipkin compatibility mode","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"compatibility-mode","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jaeger.zipkin","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig index 27646fbce53..d8d01077da6 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.mongodb.deployment.MongoClientBuildTimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.health.enabled","additionalKeys":[],"configDoc":"Whether a health check is published in case the smallrye-health extension is present.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published in case a metrics extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.tracing.enabled","additionalKeys":[],"configDoc":"Whether tracing spans of driver commands are sent in case the smallrye-opentracing extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.force-default-clients","additionalKeys":[],"configDoc":"If set to true, the default clients will always be created even if there are no injection points that use them","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-default-clients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mongodb.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mongodb.devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mongodb.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.mongodb.devservices.properties","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.mongodb.devservices.container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.health.enabled","additionalKeys":[],"configDoc":"Whether a health check is published in case the smallrye-health extension is present.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"health-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.metrics.enabled","additionalKeys":[],"configDoc":"Whether metrics are published in case a metrics extension is present.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.mongodb.force-default-clients","additionalKeys":[],"configDoc":"If set to true, the default clients will always be created even if there are no injection points that use them","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-default-clients","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.mongodb.devservices.enabled","additionalKeys":[],"configDoc":"If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.mongodb.devservices.image-name","additionalKeys":[],"configDoc":"The container image name to use, for container based DevServices providers.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.mongodb.devservices.port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.mongodb.devservices.properties","additionalKeys":[],"configDoc":"Generic properties that are added to the connection URL.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"properties","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.mongodb.devservices.container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.mongodb","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig index 755c48936dd..bbf99bbfb81 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"string","key":"quarkus.oidc.auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":"quarkus.oidc.credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"RUN_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":false,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":"quarkus.oidc.tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"RUN_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"path","key":"quarkus.oidc.tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.oidc.tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":"quarkus.oidc.application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":false,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"RUN_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":"quarkus.oidc.roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"RUN_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":"quarkus.oidc.token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":"quarkus.oidc.authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":false,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"RUN_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":"quarkus.oidc.authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":false,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":"quarkus.oidc.token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":"quarkus.oidc.provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocSection":{"name":"quarkus.oidc.named-tenants","optional":false,"withinAMap":false,"sectionDetails":"= Additional named tenants","sectionDetailsTitle":"Additional named tenants","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.oidc","configGroupType":"io.quarkus.oidc.OidcTenantConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":true,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.\"tenant\".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":"quarkus.oidc.\"tenant\".credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"RUN_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":true,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":"quarkus.oidc.\"tenant\".tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"RUN_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"path","key":"quarkus.oidc.\"tenant\".tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.oidc.\"tenant\".tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":"quarkus.oidc.\"tenant\".application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":true,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"RUN_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":"quarkus.oidc.\"tenant\".roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"RUN_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.\"tenant\".token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":true,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":"quarkus.oidc.\"tenant\".token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":true,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":true,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":true,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":"quarkus.oidc.\"tenant\".authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":true,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"RUN_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":true,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":"quarkus.oidc.\"tenant\".authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":true,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":"quarkus.oidc.\"tenant\".token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":true,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":"quarkus.oidc.\"tenant\".provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":"quarkus.oidc.token-cache.max-size","additionalKeys":[],"configDoc":"Maximum number of cache entries. Set it to a positive value if the cache has to be enabled.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token-cache.time-to-live","additionalKeys":[],"configDoc":"Maximum amount of time a given cache entry is valid for.","withinAMap":false,"defaultValue":"3M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token-cache.clean-up-timer-interval","additionalKeys":[],"configDoc":"Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}}] \ No newline at end of file +[{"configDocKey":{"type":"string","key":"quarkus.oidc.auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":false,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":false,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":"quarkus.oidc.credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"RUN_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":false,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":"quarkus.oidc.tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"RUN_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"path","key":"quarkus.oidc.tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.oidc.tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":"quarkus.oidc.application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":false,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"RUN_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":"quarkus.oidc.roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"RUN_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":"quarkus.oidc.token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":false,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":false,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":"quarkus.oidc.authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":false,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"RUN_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":"quarkus.oidc.authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":false,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":false,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":"quarkus.oidc.token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":false,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.jwks.resolve-early","additionalKeys":[],"configDoc":"If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.\n\nDisabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resolve-early","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.jwks.cache-size","additionalKeys":[],"configDoc":"Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.jwks.cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.jwks.clean-up-timer-interval","additionalKeys":[],"configDoc":"Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":"quarkus.oidc.provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocSection":{"name":"quarkus.oidc.named-tenants","optional":false,"withinAMap":false,"sectionDetails":"= Additional named tenants","sectionDetailsTitle":"Additional named tenants","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.oidc","configGroupType":"io.quarkus.oidc.OidcTenantConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".auth-server-url","additionalKeys":[],"configDoc":"The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: `https://host:port/realms/++{++realm++}++` where `++{++realm++}++` has to be replaced by the name of the Keycloak realm.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"auth-server-url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".discovery-enabled","additionalKeys":[],"configDoc":"Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"discovery-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".revoke-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC token revocation endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"revoke-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".client-id","additionalKeys":[],"configDoc":"The client-id of the application. Each application has a client-id that is used to identify the application","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".connection-delay","additionalKeys":[],"configDoc":"The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to `20S` will allow for requesting the connection up to 10 times with a 2 seconds delay between the retries. Note this property is only effective when the initial OIDC connection is created, for example, when requesting a well-known OIDC configuration. Use the 'connection-retry-count' property to support trying to re-establish an already available connection which may have been dropped.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-delay","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".connection-retry-count","additionalKeys":[],"configDoc":"The number of times an attempt to re-establish an already available connection will be repeated. Note this property is different from the `connection-delay` property, which is only effective during the initial OIDC connection creation. This property is used to try to recover an existing connection that may have been temporarily lost. For example, if a request to the OIDC token endpoint fails due to a connection exception, then the request will be retried the number of times configured by this property.","withinAMap":true,"defaultValue":"3","javaDocSiteLink":"","docMapKey":"connection-retry-count","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".connection-timeout","additionalKeys":[],"configDoc":"The amount of time after which the current OIDC connection request will time out.","withinAMap":true,"defaultValue":"10S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"connection-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.\"tenant\".max-pool-size","additionalKeys":[],"configDoc":"The maximum size of the connection pool used by the WebClient","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-pool-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.secret","additionalKeys":[],"configDoc":"Client secret which is used for a `client_secret_basic` authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.value","additionalKeys":[],"configDoc":"The client secret value - it will be ignored if 'secret.key' is set","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"value","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.client-secret.provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Secret.Method","key":"quarkus.oidc.\"tenant\".credentials.client-secret.method","additionalKeys":[],"configDoc":"Authentication method.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"method","configPhase":"RUN_TIME","acceptedValues":["tooltip:basic[client_secret_basic (default): client id and secret are submitted with the HTTP Authorization Basic scheme]","tooltip:post[client_secret_post: client id and secret are submitted as the `client_id` and `client_secret` form parameters.]","tooltip:post-jwt[client_secret_jwt: client id and generated JWT secret are submitted as the `client_id` and `client_secret` form parameters.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret-provider.name","additionalKeys":[],"configDoc":"The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.secret-provider.key","additionalKeys":[],"configDoc":"The CredentialsProvider client secret key","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the `signature-algorithm` property to specify the key algorithm.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-store-file","additionalKeys":[],"configDoc":"If provided, indicates that JWT is signed using a private key from a keystore","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-id","additionalKeys":[],"configDoc":"The private key id/alias","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.key-password","additionalKeys":[],"configDoc":"The private key password","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.audience","additionalKeys":[],"configDoc":"JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.token-key-id","additionalKeys":[],"configDoc":"Key identifier of the signing key added as a JWT 'kid' header","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-key-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.issuer","additionalKeys":[],"configDoc":"Issuer of the signing key added as a JWT `iss` claim (default: client id)","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.subject","additionalKeys":[],"configDoc":"Subject of the signing key added as a JWT 'sub' claim (default: client id)","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"subject","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".credentials.jwt.claims","additionalKeys":[],"configDoc":"Additional claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claims","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".credentials.jwt.signature-algorithm","additionalKeys":[],"configDoc":"Signature algorithm, also used for the `key-file` property. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".credentials.jwt.lifespan","additionalKeys":[],"configDoc":"JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.host","additionalKeys":[],"configDoc":"The host (name or IP address) of the Proxy. +\nNote: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the \"host\" config item must be configured to enable the usage of a Proxy.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"host","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".proxy.port","additionalKeys":[],"configDoc":"The port number of the Proxy. Default value is 80.","withinAMap":true,"defaultValue":"80","javaDocSiteLink":"","docMapKey":"port","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.username","additionalKeys":[],"configDoc":"The username, if Proxy needs authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"username","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".proxy.password","additionalKeys":[],"configDoc":"The password, if Proxy needs authentication.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.common.runtime.OidcCommonConfig.Tls.Verification","key":"quarkus.oidc.\"tenant\".tls.verification","additionalKeys":[],"configDoc":"Certificate validation and hostname verification, which can be one of the following `Verification` values. Default is required.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"verification","configPhase":"RUN_TIME","acceptedValues":["tooltip:required[Certificates are validated and hostname verification is enabled. This is the default value.]","tooltip:certificate-validation[Certificates are validated but hostname verification is disabled.]","tooltip:none[All certificated are trusted and hostname verification is disabled.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"path","key":"quarkus.oidc.\"tenant\".tls.key-store-file","additionalKeys":[],"configDoc":"An optional keystore which holds the certificate information instead of specifying separate files.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the keystore file. If not given, the type is automatically detected based on the file name.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the keystore file. If not given, the default (\"password\") is used.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-key-alias","additionalKeys":[],"configDoc":"An optional parameter to select a specific key in the keystore. When SNI is disabled, if the keystore contains multiple keys and no alias is specified, the behavior is undefined.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.key-store-key-password","additionalKeys":[],"configDoc":"An optional parameter to define the password for the key, in case it's different from `key-store-password`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"key-store-key-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"path","key":"quarkus.oidc.\"tenant\".tls.trust-store-file","additionalKeys":[],"configDoc":"An optional truststore which holds the certificate information of the certificates to trust","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-password","additionalKeys":[],"configDoc":"A parameter to specify the password of the truststore file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-cert-alias","additionalKeys":[],"configDoc":"A parameter to specify the alias of the truststore certificate.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-cert-alias","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-file-type","additionalKeys":[],"configDoc":"An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-file-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tls.trust-store-provider","additionalKeys":[],"configDoc":"An optional parameter to specify a provider of the truststore file. If not given, the provider is automatically detected based on the truststore file type.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"trust-store-provider","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".tenant-id","additionalKeys":[],"configDoc":"A unique tenant identifier. It must be set by `TenantConfigResolver` providers which resolve the tenant configuration dynamically and is optional in all other cases.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"tenant-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".tenant-enabled","additionalKeys":[],"configDoc":"If this tenant configuration is enabled. Note that the default tenant will be disabled if it is not configured but either `TenantConfigResolver` which will resolve tenant configurations is registered or named tenants are configured. You do not have to disable the default tenant in this case.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"tenant-enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.ApplicationType","key":"quarkus.oidc.\"tenant\".application-type","additionalKeys":[],"configDoc":"The application type, which can be one of the following `ApplicationType` values.","withinAMap":true,"defaultValue":"service","javaDocSiteLink":"","docMapKey":"application-type","configPhase":"RUN_TIME","acceptedValues":["tooltip:web-app[A `WEB_APP` is a client that serves pages, usually a front-end application. For this type of client the Authorization Code Flow is defined as the preferred method for authenticating users.]","tooltip:service[A `SERVICE` is a client that has a set of protected HTTP resources, usually a backend application following the RESTful Architectural Design. For this type of client, the Bearer Authorization method is defined as the preferred method for authenticating and authorizing users.]","tooltip:hybrid[A combined `SERVICE` and `WEB_APP` client. For this type of client, the Bearer Authorization method will be used if the Authorization header is set and Authorization Code Flow - if not.]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authorization-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"authorization-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".user-info-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC UserInfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and `authentication.user-info-required` property is enabled. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"user-info-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"introspection-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".jwks-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"jwks-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".end-session-path","additionalKeys":[],"configDoc":"Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"end-session-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".public-key","additionalKeys":[],"configDoc":"Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"public-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-credentials.name","additionalKeys":[],"configDoc":"Name","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".introspection-credentials.secret","additionalKeys":[],"configDoc":"Secret","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".introspection-credentials.include-client-id","additionalKeys":[],"configDoc":"Include OpenId Connect Client ID configured with 'quarkus.oidc.client-id'","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"include-client-id","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".roles.role-claim-path","additionalKeys":[],"configDoc":"List of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: \"realm/groups\". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in one or more different claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".roles.role-claim-separator","additionalKeys":[],"configDoc":"Separator for splitting a string which may contain multiple group values. It will only be used if the \"role-claim-path\" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"role-claim-separator","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Roles.Source","key":"quarkus.oidc.\"tenant\".roles.source","additionalKeys":[],"configDoc":"Source of the principal roles.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"source","configPhase":"RUN_TIME","acceptedValues":["tooltip:idtoken[ID Token - the default value for the 'web-app' applications.]","tooltip:accesstoken[Access Token - the default value for the 'service' applications; can also be used as the source of roles for the 'web-app' applications.]","tooltip:userinfo[User Info]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.issuer","additionalKeys":[],"configDoc":"Expected issuer `iss` claim value. Note this property overrides the `issuer` property which may be set in OpenId Connect provider's well-known configuration. If the `iss` claim value varies depending on the host/IP address or tenant id of the provider then you may skip the issuer verification by setting this property to 'any' but it should be done only when other options (such as configuring the provider to use the fixed `iss` claim value) are not possible.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"issuer","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.audience","additionalKeys":[],"configDoc":"Expected audience 'aud' claim value which may be a string or an array of strings. Note the audience claim will be verified for ID tokens by default. ID token audience must be equal to the value of `quarkus.oidc.client-id` property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to `any` if your provider does not set ID token audience` claim. Audience verification for access tokens will only be done if this property is configured.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"audience","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.subject-required","additionalKeys":[],"configDoc":"Require that the token includes a `sub` (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required then both the token and UserInfo `sub` claims must be present and match each other.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"subject-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".token.required-claims","additionalKeys":[],"configDoc":"A map of required claims and their expected values. For example, `quarkus.oidc.token.required-claims.org_id = org_xyz` would require tokens to have the `org_id` claim to be present and set to `org_xyz`. Strings are the only supported types. Use `SecurityIdentityAugmentor` to verify claims of other types or complex claims.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"claim-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.token-type","additionalKeys":[],"configDoc":"Expected token type","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-type","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.oidc.\"tenant\".token.lifespan-grace","additionalKeys":[],"configDoc":"Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"lifespan-grace","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.age","additionalKeys":[],"configDoc":"Token age. It allows for the number of seconds to be specified that must not elapse since the `iat` (issued at) time. A small leeway to account for clock skew which can be configured with 'quarkus.oidc.token.lifespan-grace' to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid ('exp') expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an 'exp' claim. However, even if the current logout token is allowed to have no 'exp' claim, the `exp` claim will be still verified if the logout token contains it.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"age","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.principal-claim","additionalKeys":[],"configDoc":"Name of the claim which contains a principal name. By default, the `upn`, `preferred_username` and `sub` claims are checked.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"principal-claim","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.refresh-expired","additionalKeys":[],"configDoc":"Refresh expired authorization code flow ID or access tokens. If this property is enabled then a refresh token request will be performed if the authorization code ID or access token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the `authentication.session-age-extension` property should also be set to a non-zero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type `ApplicationType++#++WEB_APP`++}++. This property will be enabled if `quarkus.oidc.token.refresh-token-time-skew` is configured, you do not have to enable this property manually in this case.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"refresh-expired","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.refresh-token-time-skew","additionalKeys":[],"configDoc":"Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token's expiration time then a refresh is going to happen.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"refresh-token-time-skew","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".token.forced-jwk-refresh-interval","additionalKeys":[],"configDoc":"Forced JWK set refresh interval in minutes.","withinAMap":true,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"forced-jwk-refresh-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.header","additionalKeys":[],"configDoc":"Custom HTTP header that contains a bearer token. This option is valid only when the application is of type `ApplicationType++#++SERVICE`++}++.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.SignatureAlgorithm","key":"quarkus.oidc.\"tenant\".token.signature-algorithm","additionalKeys":[],"configDoc":"Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"signature-algorithm","configPhase":"RUN_TIME","acceptedValues":["`rs256`","`rs384`","`rs512`","`ps256`","`ps384`","`ps512`","`es256`","`es384`","`es512`","`eddsa`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.decryption-key-location","additionalKeys":[],"configDoc":"Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers may not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. Note that if a `private_key_jwt` client authentication method is used then the private key which is used to sign client authentication JWT tokens will be used to try to decrypt an encrypted ID token if this property is not set.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"decryption-key-location","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.allow-jwt-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to `true` by default for backward-compatibility reasons and will be set to `false` instead in one of the next releases. Also note this property will be ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-jwt-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.require-jwt-introspection-only","additionalKeys":[],"configDoc":"Require that JWT tokens are only introspected remotely.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"require-jwt-introspection-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token.allow-opaque-token-introspection","additionalKeys":[],"configDoc":"Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-opaque-token-introspection","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token.customizer-name","additionalKeys":[],"configDoc":"Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using `TenantFeature` qualifier when registering custom `TokenCustomizer`. Use this property only to refer to `TokenCustomizer` implementations provided by this extension.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"customizer-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".token.verify-access-token-with-user-info","additionalKeys":[],"configDoc":"Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens have to be accepted but OpenId Connect provider does not have a token introspection endpoint. This property will have no effect when JWT tokens have to be verified.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token-with-user-info","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.path","additionalKeys":[],"configDoc":"The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.post-logout-path","additionalKeys":[],"configDoc":"Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"post-logout-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.post-logout-uri-param","additionalKeys":[],"configDoc":"Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.","withinAMap":true,"defaultValue":"post_logout_redirect_uri","javaDocSiteLink":"","docMapKey":"post-logout-uri-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".logout.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the logout redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.backchannel.path","additionalKeys":[],"configDoc":"The relative path of the Back-Channel Logout endpoint at the application.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".logout.backchannel.token-cache-size","additionalKeys":[],"configDoc":"Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"token-cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".logout.backchannel.token-cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a logout token can be cached for.","withinAMap":true,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"token-cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".logout.backchannel.clean-up-timer-interval","additionalKeys":[],"configDoc":"Token cache timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.backchannel.logout-token-key","additionalKeys":[],"configDoc":"Logout token claim whose value will be used as a key for caching the tokens. Only `sub` (subject) and `sid` (session id) claims can be used as keys. Set it to `sid` only if ID tokens issued by the OIDC provider have no `sub` but have `sid` claim.","withinAMap":true,"defaultValue":"sub","javaDocSiteLink":"","docMapKey":"logout-token-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".logout.frontchannel.path","additionalKeys":[],"configDoc":"The relative path of the Front-Channel Logout endpoint at the application.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.ResponseMode","key":"quarkus.oidc.\"tenant\".authentication.response-mode","additionalKeys":[],"configDoc":"Authorization code flow response mode","withinAMap":true,"defaultValue":"query","javaDocSiteLink":"","docMapKey":"response-mode","configPhase":"RUN_TIME","acceptedValues":["tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]","tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type]"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.redirect-path","additionalKeys":[],"configDoc":"Relative path for calculating a `redirect_uri` query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a `redirect_uri` parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to `true`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"redirect-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.restore-path-after-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"restore-path-after-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.remove-redirect-parameters","additionalKeys":[],"configDoc":"Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"remove-redirect-parameters","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.error-path","additionalKeys":[],"configDoc":"Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an `error` and an optional `error_description` parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"error-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.verify-access-token","additionalKeys":[],"configDoc":"Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"verify-access-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.force-redirect-https-scheme","additionalKeys":[],"configDoc":"Force 'https' as the `redirect_uri` parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"force-redirect-https-scheme","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.scopes","additionalKeys":[],"configDoc":"List of scopes","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"scopes","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.nonce-required","additionalKeys":[],"configDoc":"Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token or if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"nonce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.add-openid-scope","additionalKeys":[],"configDoc":"Add the `openid` scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"add-openid-scope","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".authentication.extra-params","additionalKeys":[],"configDoc":"Additional properties which will be added as the query parameters to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.forward-params","additionalKeys":[],"configDoc":"Request URL query parameters which, if present, will be added to the authentication redirect URI.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"forward-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the state, session and post logout cookies will have their 'secure' parameter set to `true` when HTTP is used. It may be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-suffix","additionalKeys":[],"configDoc":"Cookie name suffix. For example, a session cookie name for the default OIDC tenant is `q_session` but can be changed to `q_session_test` if this property is set to `test`.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-suffix","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-path","additionalKeys":[],"configDoc":"Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.","withinAMap":true,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-path-header","additionalKeys":[],"configDoc":"Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-path-header","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.cookie-domain","additionalKeys":[],"configDoc":"Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Authentication.CookieSameSite","key":"quarkus.oidc.\"tenant\".authentication.cookie-same-site","additionalKeys":[],"configDoc":"SameSite attribute for the session cookie.","withinAMap":true,"defaultValue":"lax","javaDocSiteLink":"","docMapKey":"cookie-same-site","configPhase":"RUN_TIME","acceptedValues":["`strict`","`lax`","`none`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.allow-multiple-code-flows","additionalKeys":[],"configDoc":"If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-multiple-code-flows","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.fail-on-missing-state-param","additionalKeys":[],"configDoc":"Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n\nWhen either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser will block it and the state cookie created by Quarkus will remain in the browser cache. Quarkus will report an authentication failure when it will detect such an old state cookie but find no matching state query parameter.\n\nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling `java-script-auto-redirect` or having the provider redirect to URL configured with `redirect-path` may be needed to avoid such errors.\n\nHowever, setting this property to `false` may help if the above options are not suitable. It will cause a new authentication redirect to OpenId Connect provider. Doing so may increase the risk of browser redirect loops.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"fail-on-missing-state-param","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.user-info-required","additionalKeys":[],"configDoc":"If this property is set to `true` then an OIDC UserInfo endpoint will be called. This property will be enabled if `quarkus.oidc.roles.source` is `userinfo` or `quarkus.oidc.token.verify-access-token-with-user-info` is `true` or `quarkus.oidc.authentication.id-token-required` is set to `false`, you do not have to enable this property manually in these cases.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"user-info-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".authentication.session-age-extension","additionalKeys":[],"configDoc":"Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value, then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"session-age-extension","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".authentication.java-script-auto-redirect","additionalKeys":[],"configDoc":"If this property is set to `true` then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single-page applications (SPA) since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.\n\nIf this property is set to 'false' then a status code of '499' will be returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. 'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by default if this property is enabled. You can register a custom `JavaScriptRequestChecker` to do a custom JavaScript request check instead.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"java-script-auto-redirect","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.id-token-required","additionalKeys":[],"configDoc":"Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"id-token-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".authentication.internal-id-token-lifespan","additionalKeys":[],"configDoc":"Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.","withinAMap":true,"defaultValue":"5M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"internal-id-token-lifespan","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.oidc.\"tenant\".authentication.pkce-required","additionalKeys":[],"configDoc":"Requires that a Proof Key for Code Exchange (PKCE) is used.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"pkce-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".authentication.state-secret","additionalKeys":[],"configDoc":"Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. Client secret will not be used as a state encryption secret if it is less than 32 characters long.\n\nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nError will be reported if the secret length is less than 16 characters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"state-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".code-grant.extra-params","additionalKeys":[],"configDoc":"Additional parameters, in addition to the required `code` and `redirect-uri` parameters, which have to be included to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"extra-params","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.oidc.\"tenant\".code-grant.headers","additionalKeys":[],"configDoc":"Custom HTTP headers which have to be sent to complete the authorization code grant request.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"headers","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.TokenStateManager.Strategy","key":"quarkus.oidc.\"tenant\".token-state-manager.strategy","additionalKeys":[],"configDoc":"Default TokenStateManager strategy.","withinAMap":true,"defaultValue":"keep-all-tokens","javaDocSiteLink":"","docMapKey":"strategy","configPhase":"RUN_TIME","acceptedValues":["tooltip:keep-all-tokens[Keep ID, access and refresh tokens.]","tooltip:id-token[Keep ID token only]","tooltip:id-refresh-tokens[Keep ID and refresh tokens only]"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token-state-manager.split-tokens","additionalKeys":[],"configDoc":"Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"split-tokens","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".token-state-manager.encryption-required","additionalKeys":[],"configDoc":"Mandates that the Default TokenStateManager will encrypt the session cookie that stores the tokens.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"encryption-required","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.oidc.\"tenant\".token-state-manager.encryption-secret","additionalKeys":[],"configDoc":"Secret which will be used by the Default TokenStateManager to encrypt the session cookie storing the tokens when `encryption-required` property is enabled.\n\nIf this secret is not set, the client secret configured with either `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked. Finally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be checked. The secret will be auto-generated if it remains uninitialized after checking all of these properties.\n\nThe length of the secret which will be used to encrypt the tokens should be at least 32 characters long. Warning will be logged if the secret length is less than 16 characters.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"encryption-secret","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".allow-token-introspection-cache","additionalKeys":[],"configDoc":"Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-token-introspection-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".allow-user-info-cache","additionalKeys":[],"configDoc":"Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see `OidcConfig.TokenCache` to enable it.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"allow-user-info-cache","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".cache-user-info-in-idtoken","additionalKeys":[],"configDoc":"Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-user-info-in-idtoken","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.oidc.\"tenant\".jwks.resolve-early","additionalKeys":[],"configDoc":"If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.\n\nDisabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.","withinAMap":true,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"resolve-early","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.oidc.\"tenant\".jwks.cache-size","additionalKeys":[],"configDoc":"Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":true,"defaultValue":"10","javaDocSiteLink":"","docMapKey":"cache-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".jwks.cache-time-to-live","additionalKeys":[],"configDoc":"Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":true,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cache-time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.\"tenant\".jwks.clean-up-timer-interval","additionalKeys":[],"configDoc":"Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"io.quarkus.oidc.OidcTenantConfig.Provider","key":"quarkus.oidc.\"tenant\".provider","additionalKeys":[],"configDoc":"Well known OpenId Connect provider identifier","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"provider","configPhase":"RUN_TIME","acceptedValues":["`apple`","`discord`","`facebook`","`github`","`google`","`mastodon`","`microsoft`","`spotify`","`twitch`","`twitter`","`x`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":true}}],"anchorPrefix":null}},{"configDocKey":{"type":"int","key":"quarkus.oidc.token-cache.max-size","additionalKeys":[],"configDoc":"Maximum number of cache entries. Set it to a positive value if the cache has to be enabled.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token-cache.time-to-live","additionalKeys":[],"configDoc":"Maximum amount of time a given cache entry is valid for.","withinAMap":false,"defaultValue":"3M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"time-to-live","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.oidc.token-cache.clean-up-timer-interval","additionalKeys":[],"configDoc":"Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"clean-up-timer-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.oidc","enum":false}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig index 31033bd6b2a..a0703767375 100644 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig +++ b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig @@ -1 +1 @@ -[{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocSection":{"name":"quarkus.datasource.named-data-sources","optional":false,"withinAMap":false,"sectionDetails":"= Additional named datasources","sectionDetailsTitle":"Additional named datasources","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.datasource","configGroupType":"io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.\"datasource-name\".reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":true,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":true,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.\"datasource-name\".reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file +[{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":false,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":false,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":false,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocSection":{"name":"quarkus.datasource.named-data-sources","optional":false,"withinAMap":false,"sectionDetails":"= Additional named datasources","sectionDetailsTitle":"Additional named datasources","configPhase":"RUN_TIME","topLevelGrouping":"quarkus.datasource","configGroupType":"io.quarkus.reactive.datasource.runtime.DataSourcesReactiveRuntimeConfig.DataSourceReactiveOuterNamedRuntimeConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.cache-prepared-statements","additionalKeys":[],"configDoc":"Whether prepared statements should be cached on the client side.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cache-prepared-statements","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.url","additionalKeys":[],"configDoc":"The datasource URLs.\n\nIf multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"url","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".reactive.max-size","additionalKeys":[],"configDoc":"The datasource pool maximum size.","withinAMap":true,"defaultValue":"20","javaDocSiteLink":"","docMapKey":"max-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.datasource.\"datasource-name\".reactive.event-loop-size","additionalKeys":[],"configDoc":"When a new connection object is created, the pool assigns it an event loop.\n\nWhen `++#++event-loop-size` is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If `++#++event-loop-size` is set to zero or a negative value, the pool assigns the current event loop to the new connection.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"event-loop-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-all","additionalKeys":[],"configDoc":"Whether all server certificates should be trusted.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"trust-all","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pem","additionalKeys":[],"configDoc":"PEM Trust config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the trust certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.trust-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem","additionalKeys":[],"configDoc":"PEM Key/cert config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem.keys","additionalKeys":[],"configDoc":"Comma-separated list of the path to the key files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"keys","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pem.certs","additionalKeys":[],"configDoc":"Comma-separated list of the path to the certificate files (Pem format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"certs","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks","additionalKeys":[],"configDoc":"JKS config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks.path","additionalKeys":[],"configDoc":"Path of the key file (JKS format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-jks.password","additionalKeys":[],"configDoc":"Password of the key file.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx","additionalKeys":[],"configDoc":"PFX config is disabled by default.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx.path","additionalKeys":[],"configDoc":"Path to the key file (PFX format).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.key-certificate-pfx.password","additionalKeys":[],"configDoc":"Password of the key.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"password","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.datasource.\"datasource-name\".reactive.reconnect-attempts","additionalKeys":[],"configDoc":"The number of reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"0","javaDocSiteLink":"","docMapKey":"reconnect-attempts","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.reconnect-interval","additionalKeys":[],"configDoc":"The interval between reconnection attempts when a pooled connection cannot be established on first try.","withinAMap":true,"defaultValue":"PT1S","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"reconnect-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.hostname-verification-algorithm","additionalKeys":[],"configDoc":"The hostname verification algorithm to use in case the server's identity should be checked. Should be HTTPS, LDAPS or an empty string.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"hostname-verification-algorithm","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.idle-timeout","additionalKeys":[],"configDoc":"The maximum time a connection remains unused in the pool before it is closed.","withinAMap":true,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"idle-timeout","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.datasource.\"datasource-name\".reactive.max-lifetime","additionalKeys":[],"configDoc":"The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.","withinAMap":true,"defaultValue":"no timeout","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"max-lifetime","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.datasource.\"datasource-name\".reactive.shared","additionalKeys":[],"configDoc":"Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the `__vertx.DEFAULT` name is used.","withinAMap":true,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"shared","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.datasource.\"datasource-name\".reactive.name","additionalKeys":[],"configDoc":"Set the pool name, used when the pool is shared among datasources, otherwise ignored.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"name","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}},{"configDocKey":{"type":"`Map`","key":"quarkus.datasource.\"datasource-name\".reactive.additional-properties","additionalKeys":[],"configDoc":"Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-properties","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.datasource","enum":false}}],"anchorPrefix":null}}] \ No newline at end of file diff --git a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.smallrye.opentracing.runtime.TracingConfig b/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.smallrye.opentracing.runtime.TracingConfig deleted file mode 100644 index 9cbc4b7c4e8..00000000000 --- a/_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.smallrye.opentracing.runtime.TracingConfig +++ /dev/null @@ -1 +0,0 @@ -[{"configDocKey":{"type":"string","key":"quarkus.opentracing.server.skip-pattern","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"skip-pattern","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.opentracing","enum":false}},{"configDocKey":{"type":"io.quarkus.smallrye.opentracing.runtime.TracingConfig.OperationNameProvider","key":"quarkus.opentracing.server.operation-name-provider","additionalKeys":[],"configDoc":"","withinAMap":false,"defaultValue":"class-method","javaDocSiteLink":"","docMapKey":"operation-name-provider","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`http-path`","`class-method`"],"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.opentracing","enum":true}}] \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig deleted file mode 100644 index 384d6985325..00000000000 --- a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerBuildTimeConfig +++ /dev/null @@ -1 +0,0 @@ -io.quarkus.jaeger.runtime.JaegerBuildTimeConfig \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerConfig deleted file mode 100644 index 1583d741c59..00000000000 --- a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.JaegerConfig +++ /dev/null @@ -1 +0,0 @@ -io.quarkus.jaeger.runtime.JaegerConfig \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.ZipkinConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.ZipkinConfig deleted file mode 100644 index 440da33cc8c..00000000000 --- a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-jaeger.adoc/io.quarkus.jaeger.runtime.ZipkinConfig +++ /dev/null @@ -1 +0,0 @@ -io.quarkus.jaeger.runtime.ZipkinConfig \ No newline at end of file diff --git a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-smallrye-opentracing.adoc/io.quarkus.smallrye.opentracing.runtime.TracingConfig b/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-smallrye-opentracing.adoc/io.quarkus.smallrye.opentracing.runtime.TracingConfig deleted file mode 100644 index fbd8a4b6ca0..00000000000 --- a/_generated-doc/main/config/extensions-configuration-roots-list/quarkus-smallrye-opentracing.adoc/io.quarkus.smallrye.opentracing.runtime.TracingConfig +++ /dev/null @@ -1 +0,0 @@ -io.quarkus.smallrye.opentracing.runtime.TracingConfig \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-agroal-config-group-data-source-jdbc-runtime-config.adoc b/_generated-doc/main/config/quarkus-agroal-config-group-data-source-jdbc-runtime-config.adoc index f8d9164369d..520998c8644 100644 --- a/_generated-doc/main/config/quarkus-agroal-config-group-data-source-jdbc-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-agroal-config-group-data-source-jdbc-runtime-config.adoc @@ -149,7 +149,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.jdbc.idle-removal-interval]]`link:#quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.jdbc.idle-removal-interval[quarkus.datasource.jdbc.idle-removal-interval]` @@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.jdbc.transaction-isolation-level]]`link:#quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.jdbc.transaction-isolation-level[quarkus.datasource.jdbc.transaction-isolation-level]` @@ -245,7 +245,7 @@ a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasou [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -296,7 +296,7 @@ a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasou [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED+++[] @@ -550,7 +550,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -586,7 +586,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -646,7 +646,7 @@ a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasou [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -697,7 +697,7 @@ a| [[quarkus-agroal-config-group-data-source-jdbc-runtime-config_quarkus.datasou [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] diff --git a/_generated-doc/main/config/quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config.adoc b/_generated-doc/main/config/quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config.adoc index d59be9c8711..1d76aecf741 100644 --- a/_generated-doc/main/config/quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config.adoc @@ -149,7 +149,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -245,7 +245,7 @@ a| [[quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jd [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -296,7 +296,7 @@ a| [[quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jd [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] diff --git a/_generated-doc/main/config/quarkus-agroal-general-config-items.adoc b/_generated-doc/main/config/quarkus-agroal-general-config-items.adoc index 672928917af..c18ca090bd0 100644 --- a/_generated-doc/main/config/quarkus-agroal-general-config-items.adoc +++ b/_generated-doc/main/config/quarkus-agroal-general-config-items.adoc @@ -149,7 +149,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal-general-config-items_quarkus.datasource.jdbc.idle-removal-interval]]`link:#quarkus-agroal-general-config-items_quarkus.datasource.jdbc.idle-removal-interval[quarkus.datasource.jdbc.idle-removal-interval]` @@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal-general-config-items_quarkus.datasource.jdbc.transaction-isolation-level]]`link:#quarkus-agroal-general-config-items_quarkus.datasource.jdbc.transaction-isolation-level[quarkus.datasource.jdbc.transaction-isolation-level]` @@ -245,7 +245,7 @@ a| [[quarkus-agroal-general-config-items_quarkus.datasource.jdbc.detect-statemen [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -296,7 +296,7 @@ a| [[quarkus-agroal-general-config-items_quarkus.datasource.jdbc.pooling-enabled [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED+++[] @@ -677,7 +677,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -713,7 +713,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -773,7 +773,7 @@ a| [[quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jd [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -824,7 +824,7 @@ a| [[quarkus-agroal-general-config-items_quarkus.datasource.-datasource-name-.jd [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] diff --git a/_generated-doc/main/config/quarkus-agroal.adoc b/_generated-doc/main/config/quarkus-agroal.adoc index ca181d27fdd..912972291e0 100644 --- a/_generated-doc/main/config/quarkus-agroal.adoc +++ b/_generated-doc/main/config/quarkus-agroal.adoc @@ -149,7 +149,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal_quarkus.datasource.jdbc.idle-removal-interval]]`link:#quarkus-agroal_quarkus.datasource.jdbc.idle-removal-interval[quarkus.datasource.jdbc.idle-removal-interval]` @@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus.datasource.jdbc.transaction-isolation-level]]`link:#quarkus-agroal_quarkus.datasource.jdbc.transaction-isolation-level[quarkus.datasource.jdbc.transaction-isolation-level]` @@ -245,7 +245,7 @@ a| [[quarkus-agroal_quarkus.datasource.jdbc.detect-statement-leaks]]`link:#quark [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -296,7 +296,7 @@ a| [[quarkus-agroal_quarkus.datasource.jdbc.pooling-enabled]]`link:#quarkus-agro [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED+++[] @@ -677,7 +677,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -713,7 +713,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -773,7 +773,7 @@ a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.detect-statement-l [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -824,7 +824,7 @@ a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.pooling-enabled]]` [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] diff --git a/_generated-doc/main/config/quarkus-all-build-items.adoc b/_generated-doc/main/config/quarkus-all-build-items.adoc index 211e3e68b71..fcde94bc624 100644 --- a/_generated-doc/main/config/quarkus-all-build-items.adoc +++ b/_generated-doc/main/config/quarkus-all-build-items.adoc @@ -1642,6 +1642,12 @@ a| `String path` :: +++No Javadoc found+++ `Path fullPath` :: +++No Javadoc found+++ `String content` :: +++No Javadoc found+++ +a| https://github.com/quarkusio/quarkus/blob/main/extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateRootBuildItem.java[`io.quarkus.qute.deployment.TemplateRootBuildItem`, window="_blank"] :: +++This build item represents a source of template files.

By default, the templates are found in the directory. However, an extension can produce this build item to register an additional root path.

The path is relative to the artifact/project root and OS-agnostic, i.e. is used as a path separator.+++ +a| `String path` :: +++No Javadoc found+++ + +a| https://github.com/quarkusio/quarkus/blob/main/extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateRootsBuildItem.java[`io.quarkus.qute.deployment.TemplateRootsBuildItem`, window="_blank"] :: +++The set of template root paths.+++ +a| `Set rootPaths` :: +++No Javadoc found+++ + a| https://github.com/quarkusio/quarkus/blob/main/extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateVariantsBuildItem.java[`io.quarkus.qute.deployment.TemplateVariantsBuildItem`, window="_blank"] :: +++Holds all template variants found.+++ a| `Map variants` :: +++No Javadoc found+++ diff --git a/_generated-doc/main/config/quarkus-all-config.adoc b/_generated-doc/main/config/quarkus-all-config.adoc index c867ff21a99..a5768c6f8b8 100644 --- a/_generated-doc/main/config/quarkus-all-config.adoc +++ b/_generated-doc/main/config/quarkus-all-config.adoc @@ -317,7 +317,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal_quarkus.datasource.jdbc.idle-removal-interval]]`link:#quarkus-agroal_quarkus.datasource.jdbc.idle-removal-interval[quarkus.datasource.jdbc.idle-removal-interval]` @@ -353,7 +353,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus.datasource.jdbc.transaction-isolation-level]]`link:#quarkus-agroal_quarkus.datasource.jdbc.transaction-isolation-level[quarkus.datasource.jdbc.transaction-isolation-level]` @@ -413,7 +413,7 @@ a| [[quarkus-agroal_quarkus.datasource.jdbc.detect-statement-leaks]]`link:#quark [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -464,7 +464,7 @@ a| [[quarkus-agroal_quarkus.datasource.jdbc.pooling-enabled]]`link:#quarkus-agro [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED+++[] @@ -845,7 +845,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -881,7 +881,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -941,7 +941,7 @@ a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.detect-statement-l [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -992,7 +992,7 @@ a| [[quarkus-agroal_quarkus.datasource.-datasource-name-.jdbc.pooling-enabled]]` [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] @@ -20223,354 +20223,6 @@ endif::add-copy-button-to-env-var[] |`target/jacoco-report` -h|[[quarkus-jaeger_quarkus-jaeger-jaeger]]link:#quarkus-jaeger_quarkus-jaeger-jaeger[Jaeger] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.enabled]]`link:#quarkus-jaeger_quarkus.jaeger.enabled[quarkus.jaeger.enabled]` - - -[.description] --- -Defines if the Jaeger extension is enabled. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.metrics.enabled]]`link:#quarkus-jaeger_quarkus.jaeger.metrics.enabled[quarkus.jaeger.metrics.enabled]` - - -[.description] --- -Whether metrics are published in case a metrics extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_METRICS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_METRICS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-jaeger_quarkus.jaeger.endpoint]]`link:#quarkus-jaeger_quarkus.jaeger.endpoint[quarkus.jaeger.endpoint]` - - -[.description] --- -The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-jaeger_quarkus.jaeger.auth-token]]`link:#quarkus-jaeger_quarkus.jaeger.auth-token[quarkus.jaeger.auth-token]` - - -[.description] --- -Authentication Token to send as "Bearer" to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AUTH_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AUTH_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.user]]`link:#quarkus-jaeger_quarkus.jaeger.user[quarkus.jaeger.user]` - - -[.description] --- -Username to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_USER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_USER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.password]]`link:#quarkus-jaeger_quarkus.jaeger.password[quarkus.jaeger.password]` - - -[.description] --- -Password to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.agent-host-port]]`link:#quarkus-jaeger_quarkus.jaeger.agent-host-port[quarkus.jaeger.agent-host-port]` - - -[.description] --- -The hostname and port for communicating with agent via UDP - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AGENT_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AGENT_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-log-spans]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-log-spans[quarkus.jaeger.reporter-log-spans]` - - -[.description] --- -Whether the reporter should also log the spans - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-max-queue-size]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-max-queue-size[quarkus.jaeger.reporter-max-queue-size]` - - -[.description] --- -The reporter's maximum queue size - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-flush-interval]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-flush-interval[quarkus.jaeger.reporter-flush-interval]` - - -[.description] --- -The reporter's flush interval - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-type]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-type[quarkus.jaeger.sampler-type]` - - -[.description] --- -The sampler type (const, probabilistic, ratelimiting or remote) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-param]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-param[quarkus.jaeger.sampler-param]` - - -[.description] --- -The sampler parameter (number) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_PARAM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_PARAM+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html[BigDecimal] - -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-manager-host-port]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-manager-host-port[quarkus.jaeger.sampler-manager-host-port]` - - -[.description] --- -The host name and port when using the remote controlled sampler - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger_quarkus.jaeger.service-name]]`link:#quarkus-jaeger_quarkus.jaeger.service-name[quarkus.jaeger.service-name]` - - -[.description] --- -The service name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.tags]]`link:#quarkus-jaeger_quarkus.jaeger.tags[quarkus.jaeger.tags]` - - -[.description] --- -A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format $++{++envVarName:default++}++, where the :default is optional, and identifies a value to be used if the environment variable cannot be found - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_TAGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_TAGS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.propagation]]`link:#quarkus-jaeger_quarkus.jaeger.propagation[quarkus.jaeger.propagation]` - - -[.description] --- -Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PROPAGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PROPAGATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sender-factory]]`link:#quarkus-jaeger_quarkus.jaeger.sender-factory[quarkus.jaeger.sender-factory]` - - -[.description] --- -The sender factory class name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SENDER_FACTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SENDER_FACTORY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.log-trace-context]]`link:#quarkus-jaeger_quarkus.jaeger.log-trace-context[quarkus.jaeger.log-trace-context]` - - -[.description] --- -Whether the trace context should be logged. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-jaeger_quarkus.jaeger.disable-tracer-registration]]`link:#quarkus-jaeger_quarkus.jaeger.disable-tracer-registration[quarkus.jaeger.disable-tracer-registration]` - - -[.description] --- -Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.zipkin.compatibility-mode]]`link:#quarkus-jaeger_quarkus.jaeger.zipkin.compatibility-mode[quarkus.jaeger.zipkin.compatibility-mode]` - - -[.description] --- -Whether jaeger should run in zipkin compatibility mode - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - h|[[quarkus-keycloak-admin-client-common_quarkus-keycloak-admin-client-common-keycloak-admin-client-common]]link:#quarkus-keycloak-admin-client-common_quarkus-keycloak-admin-client-common-keycloak-admin-client-common[Keycloak Admin Client Common] h|Type @@ -42186,23 +41838,6 @@ endif::add-copy-button-to-env-var[] |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-client_quarkus.mongodb.tracing.enabled]]`link:#quarkus-mongodb-client_quarkus.mongodb.tracing.enabled[quarkus.mongodb.tracing.enabled]` - - -[.description] --- -Whether tracing spans of driver commands are sent in case the smallrye-opentracing extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MONGODB_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-client_quarkus.mongodb.force-default-clients]]`link:#quarkus-mongodb-client_quarkus.mongodb.force-default-clients[quarkus.mongodb.force-default-clients]` @@ -46301,6 +45936,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc_quarkus.oidc.provider]]`link:#quarkus-oidc_quarkus.oidc.provider[quarkus.oidc.provider]` @@ -48657,6 +48364,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc_quarkus.oidc.-tenant-.provider]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.provider[quarkus.oidc."tenant".provider]` @@ -59583,7 +59362,7 @@ a| [[quarkus-reactive-datasource_quarkus.datasource.reactive.url]]`link:#quarkus -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] @@ -60122,7 +59901,7 @@ a| [[quarkus-reactive-datasource_quarkus.datasource.-datasource-name-.reactive.u -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] @@ -66010,42 +65789,6 @@ endif::add-copy-button-to-env-var[] | -h|[[quarkus-smallrye-opentracing_quarkus-smallrye-opentracing-smallrye-opentracing]]link:#quarkus-smallrye-opentracing_quarkus-smallrye-opentracing-smallrye-opentracing[SmallRye OpenTracing] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-opentracing_quarkus.opentracing.server.skip-pattern]]`link:#quarkus-smallrye-opentracing_quarkus.opentracing.server.skip-pattern[quarkus.opentracing.server.skip-pattern]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-opentracing_quarkus.opentracing.server.operation-name-provider]]`link:#quarkus-smallrye-opentracing_quarkus.opentracing.server.operation-name-provider[quarkus.opentracing.server.operation-name-provider]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- a| -`http-path`, `class-method` -|`class-method` - - h|[[quarkus-smallrye-reactive-messaging_quarkus-smallrye-reactive-messaging-smallrye-reactive-messaging]]link:#quarkus-smallrye-reactive-messaging_quarkus-smallrye-reactive-messaging-smallrye-reactive-messaging[SmallRye Reactive Messaging] h|Type diff --git a/_generated-doc/main/config/quarkus-datasource-data-sources-jdbc-runtime-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-jdbc-runtime-config.adoc index 9bd4783fb4d..f7ceb991275 100644 --- a/_generated-doc/main/config/quarkus-datasource-data-sources-jdbc-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-datasource-data-sources-jdbc-runtime-config.adoc @@ -149,7 +149,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc.idle-removal-interval]]`link:#quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc.idle-removal-interval[quarkus.datasource.jdbc.idle-removal-interval]` @@ -185,7 +185,7 @@ Environment variable: `+++QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME+++` endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc.transaction-isolation-level]]`link:#quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc.transaction-isolation-level[quarkus.datasource.jdbc.transaction-isolation-level]` @@ -245,7 +245,7 @@ a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -296,7 +296,7 @@ a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.jdbc [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED+++[] @@ -555,7 +555,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_LEAK_DETECTI endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`This feature is disabled by default.` a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval]]`link:#quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.idle-removal-interval[quarkus.datasource."datasource-name".jdbc.idle-removal-interval]` @@ -591,7 +591,7 @@ Environment variable: `+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_MAX_LIFETIME endif::add-copy-button-to-env-var[] --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| +|`By default, there is no restriction on the lifespan of a connection.` a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level]]`link:#quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-datasource-name-.jdbc.transaction-isolation-level[quarkus.datasource."datasource-name".jdbc.transaction-isolation-level]` @@ -651,7 +651,7 @@ a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-dat [.description] -- -When enabled Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. +When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there's high confidence that no leaks are happening. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_DETECT_STATEMENT_LEAKS+++[] @@ -702,7 +702,7 @@ a| [[quarkus-datasource-data-sources-jdbc-runtime-config_quarkus.datasource.-dat [.description] -- -Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. +Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__JDBC_POOLING_ENABLED+++[] diff --git a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc index 8f3eb6c111a..3e743dc9fd7 100644 --- a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-build-time-config.adoc @@ -73,7 +73,7 @@ a| [[quarkus-datasource-data-sources-reactive-build-time-config_quarkus.datasour -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc index dd6537077a1..568fd647c3e 100644 --- a/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-datasource-data-sources-reactive-runtime-config.adoc @@ -34,7 +34,7 @@ a| [[quarkus-datasource-data-sources-reactive-runtime-config_quarkus.datasource. -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] @@ -556,7 +556,7 @@ a| [[quarkus-datasource-data-sources-reactive-runtime-config_quarkus.datasource. -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-jaeger-jaeger-build-time-config.adoc b/_generated-doc/main/config/quarkus-jaeger-jaeger-build-time-config.adoc deleted file mode 100644 index 7fb51e03b92..00000000000 --- a/_generated-doc/main/config/quarkus-jaeger-jaeger-build-time-config.adoc +++ /dev/null @@ -1,46 +0,0 @@ - -:summaryTableId: quarkus-jaeger-jaeger-build-time-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-jaeger-jaeger-build-time-config_configuration]]link:#quarkus-jaeger-jaeger-build-time-config_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger-jaeger-build-time-config_quarkus.jaeger.enabled]]`link:#quarkus-jaeger-jaeger-build-time-config_quarkus.jaeger.enabled[quarkus.jaeger.enabled]` - - -[.description] --- -Defines if the Jaeger extension is enabled. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger-jaeger-build-time-config_quarkus.jaeger.metrics.enabled]]`link:#quarkus-jaeger-jaeger-build-time-config_quarkus.jaeger.metrics.enabled[quarkus.jaeger.metrics.enabled]` - - -[.description] --- -Whether metrics are published in case a metrics extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_METRICS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_METRICS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - -|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-jaeger-jaeger-config.adoc b/_generated-doc/main/config/quarkus-jaeger-jaeger-config.adoc deleted file mode 100644 index 0358a7f3aa2..00000000000 --- a/_generated-doc/main/config/quarkus-jaeger-jaeger-config.adoc +++ /dev/null @@ -1,323 +0,0 @@ - -:summaryTableId: quarkus-jaeger-jaeger-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-jaeger-jaeger-config_configuration]]link:#quarkus-jaeger-jaeger-config_configuration[Configuration property] - -h|Type -h|Default - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.endpoint]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.endpoint[quarkus.jaeger.endpoint]` - - -[.description] --- -The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.auth-token]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.auth-token[quarkus.jaeger.auth-token]` - - -[.description] --- -Authentication Token to send as "Bearer" to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AUTH_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AUTH_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.user]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.user[quarkus.jaeger.user]` - - -[.description] --- -Username to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_USER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_USER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.password]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.password[quarkus.jaeger.password]` - - -[.description] --- -Password to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.agent-host-port]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.agent-host-port[quarkus.jaeger.agent-host-port]` - - -[.description] --- -The hostname and port for communicating with agent via UDP - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AGENT_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AGENT_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-log-spans]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-log-spans[quarkus.jaeger.reporter-log-spans]` - - -[.description] --- -Whether the reporter should also log the spans - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-max-queue-size]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-max-queue-size[quarkus.jaeger.reporter-max-queue-size]` - - -[.description] --- -The reporter's maximum queue size - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-flush-interval]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.reporter-flush-interval[quarkus.jaeger.reporter-flush-interval]` - - -[.description] --- -The reporter's flush interval - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-type]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-type[quarkus.jaeger.sampler-type]` - - -[.description] --- -The sampler type (const, probabilistic, ratelimiting or remote) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-param]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-param[quarkus.jaeger.sampler-param]` - - -[.description] --- -The sampler parameter (number) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_PARAM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_PARAM+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html[BigDecimal] - -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-manager-host-port]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.sampler-manager-host-port[quarkus.jaeger.sampler-manager-host-port]` - - -[.description] --- -The host name and port when using the remote controlled sampler - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.service-name]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.service-name[quarkus.jaeger.service-name]` - - -[.description] --- -The service name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.tags]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.tags[quarkus.jaeger.tags]` - - -[.description] --- -A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format $++{++envVarName:default++}++, where the :default is optional, and identifies a value to be used if the environment variable cannot be found - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_TAGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_TAGS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.propagation]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.propagation[quarkus.jaeger.propagation]` - - -[.description] --- -Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PROPAGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PROPAGATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.sender-factory]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.sender-factory[quarkus.jaeger.sender-factory]` - - -[.description] --- -The sender factory class name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SENDER_FACTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SENDER_FACTORY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.log-trace-context]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.log-trace-context[quarkus.jaeger.log-trace-context]` - - -[.description] --- -Whether the trace context should be logged. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-jaeger-jaeger-config_quarkus.jaeger.disable-tracer-registration]]`link:#quarkus-jaeger-jaeger-config_quarkus.jaeger.disable-tracer-registration[quarkus.jaeger.disable-tracer-registration]` - - -[.description] --- -Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - -|=== -ifndef::no-duration-note[] -[NOTE] -[id='duration-note-anchor-{summaryTableId}'] -.About the Duration format -==== -To write duration values, use the standard `java.time.Duration` format. -See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] for more information. - -You can also use a simplified format, starting with a number: - -* If the value is only a number, it represents time in seconds. -* If the value is a number followed by `ms`, it represents time in milliseconds. - -In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: - -* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. -* If the value is a number followed by `d`, it is prefixed with `P`. -==== -endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-jaeger-zipkin-zipkin-config.adoc b/_generated-doc/main/config/quarkus-jaeger-zipkin-zipkin-config.adoc deleted file mode 100644 index ce00e6ba89e..00000000000 --- a/_generated-doc/main/config/quarkus-jaeger-zipkin-zipkin-config.adoc +++ /dev/null @@ -1,29 +0,0 @@ - -:summaryTableId: quarkus-jaeger-zipkin-zipkin-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-jaeger-zipkin-zipkin-config_configuration]]link:#quarkus-jaeger-zipkin-zipkin-config_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger-zipkin-zipkin-config_quarkus.jaeger.zipkin.compatibility-mode]]`link:#quarkus-jaeger-zipkin-zipkin-config_quarkus.jaeger.zipkin.compatibility-mode[quarkus.jaeger.zipkin.compatibility-mode]` - - -[.description] --- -Whether jaeger should run in zipkin compatibility mode - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - -|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-jaeger.adoc b/_generated-doc/main/config/quarkus-jaeger.adoc deleted file mode 100644 index 974b8ae3862..00000000000 --- a/_generated-doc/main/config/quarkus-jaeger.adoc +++ /dev/null @@ -1,374 +0,0 @@ - -:summaryTableId: quarkus-jaeger -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-jaeger_configuration]]link:#quarkus-jaeger_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.enabled]]`link:#quarkus-jaeger_quarkus.jaeger.enabled[quarkus.jaeger.enabled]` - - -[.description] --- -Defines if the Jaeger extension is enabled. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.metrics.enabled]]`link:#quarkus-jaeger_quarkus.jaeger.metrics.enabled[quarkus.jaeger.metrics.enabled]` - - -[.description] --- -Whether metrics are published in case a metrics extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_METRICS_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_METRICS_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-jaeger_quarkus.jaeger.endpoint]]`link:#quarkus-jaeger_quarkus.jaeger.endpoint[quarkus.jaeger.endpoint]` - - -[.description] --- -The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-jaeger_quarkus.jaeger.auth-token]]`link:#quarkus-jaeger_quarkus.jaeger.auth-token[quarkus.jaeger.auth-token]` - - -[.description] --- -Authentication Token to send as "Bearer" to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AUTH_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AUTH_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.user]]`link:#quarkus-jaeger_quarkus.jaeger.user[quarkus.jaeger.user]` - - -[.description] --- -Username to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_USER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_USER+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.password]]`link:#quarkus-jaeger_quarkus.jaeger.password[quarkus.jaeger.password]` - - -[.description] --- -Password to send as part of "Basic" authentication to the endpoint - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.agent-host-port]]`link:#quarkus-jaeger_quarkus.jaeger.agent-host-port[quarkus.jaeger.agent-host-port]` - - -[.description] --- -The hostname and port for communicating with agent via UDP - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_AGENT_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_AGENT_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-log-spans]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-log-spans[quarkus.jaeger.reporter-log-spans]` - - -[.description] --- -Whether the reporter should also log the spans - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_LOG_SPANS+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-max-queue-size]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-max-queue-size[quarkus.jaeger.reporter-max-queue-size]` - - -[.description] --- -The reporter's maximum queue size - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_MAX_QUEUE_SIZE+++` -endif::add-copy-button-to-env-var[] ---|int -| - - -a| [[quarkus-jaeger_quarkus.jaeger.reporter-flush-interval]]`link:#quarkus-jaeger_quarkus.jaeger.reporter-flush-interval[quarkus.jaeger.reporter-flush-interval]` - - -[.description] --- -The reporter's flush interval - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_REPORTER_FLUSH_INTERVAL+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-type]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-type[quarkus.jaeger.sampler-type]` - - -[.description] --- -The sampler type (const, probabilistic, ratelimiting or remote) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-param]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-param[quarkus.jaeger.sampler-param]` - - -[.description] --- -The sampler parameter (number) - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_PARAM+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_PARAM+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html[BigDecimal] - -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sampler-manager-host-port]]`link:#quarkus-jaeger_quarkus.jaeger.sampler-manager-host-port[quarkus.jaeger.sampler-manager-host-port]` - - -[.description] --- -The host name and port when using the remote controlled sampler - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SAMPLER_MANAGER_HOST_PORT+++` -endif::add-copy-button-to-env-var[] ---|host:port -| - - -a| [[quarkus-jaeger_quarkus.jaeger.service-name]]`link:#quarkus-jaeger_quarkus.jaeger.service-name[quarkus.jaeger.service-name]` - - -[.description] --- -The service name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SERVICE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SERVICE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.tags]]`link:#quarkus-jaeger_quarkus.jaeger.tags[quarkus.jaeger.tags]` - - -[.description] --- -A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format $++{++envVarName:default++}++, where the :default is optional, and identifies a value to be used if the environment variable cannot be found - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_TAGS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_TAGS+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.propagation]]`link:#quarkus-jaeger_quarkus.jaeger.propagation[quarkus.jaeger.propagation]` - - -[.description] --- -Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3 - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_PROPAGATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_PROPAGATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.sender-factory]]`link:#quarkus-jaeger_quarkus.jaeger.sender-factory[quarkus.jaeger.sender-factory]` - - -[.description] --- -The sender factory class name - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_SENDER_FACTORY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_SENDER_FACTORY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-jaeger_quarkus.jaeger.log-trace-context]]`link:#quarkus-jaeger_quarkus.jaeger.log-trace-context[quarkus.jaeger.log-trace-context]` - - -[.description] --- -Whether the trace context should be logged. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_LOG_TRACE_CONTEXT+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-jaeger_quarkus.jaeger.disable-tracer-registration]]`link:#quarkus-jaeger_quarkus.jaeger.disable-tracer-registration[quarkus.jaeger.disable-tracer-registration]` - - -[.description] --- -Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_DISABLE_TRACER_REGISTRATION+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a|icon:lock[title=Fixed at build time] [[quarkus-jaeger_quarkus.jaeger.zipkin.compatibility-mode]]`link:#quarkus-jaeger_quarkus.jaeger.zipkin.compatibility-mode[quarkus.jaeger.zipkin.compatibility-mode]` - - -[.description] --- -Whether jaeger should run in zipkin compatibility mode - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_JAEGER_ZIPKIN_COMPATIBILITY_MODE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - -|=== -ifndef::no-duration-note[] -[NOTE] -[id='duration-note-anchor-{summaryTableId}'] -.About the Duration format -==== -To write duration values, use the standard `java.time.Duration` format. -See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] for more information. - -You can also use a simplified format, starting with a number: - -* If the value is only a number, it represents time in seconds. -* If the value is a number followed by `ms`, it represents time in milliseconds. - -In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: - -* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. -* If the value is a number followed by `d`, it is prefixed with `P`. -==== -endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-mongodb-mongo-client-build-time-config.adoc b/_generated-doc/main/config/quarkus-mongodb-mongo-client-build-time-config.adoc index 527469e09fd..2e71f4fd8c3 100644 --- a/_generated-doc/main/config/quarkus-mongodb-mongo-client-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-mongodb-mongo-client-build-time-config.adoc @@ -44,23 +44,6 @@ endif::add-copy-button-to-env-var[] |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time-config_quarkus.mongodb.tracing.enabled]]`link:#quarkus-mongodb-mongo-client-build-time-config_quarkus.mongodb.tracing.enabled[quarkus.mongodb.tracing.enabled]` - - -[.description] --- -Whether tracing spans of driver commands are sent in case the smallrye-opentracing extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MONGODB_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - a|icon:lock[title=Fixed at build time] [[quarkus-mongodb-mongo-client-build-time-config_quarkus.mongodb.force-default-clients]]`link:#quarkus-mongodb-mongo-client-build-time-config_quarkus.mongodb.force-default-clients[quarkus.mongodb.force-default-clients]` diff --git a/_generated-doc/main/config/quarkus-mongodb.adoc b/_generated-doc/main/config/quarkus-mongodb.adoc index 88fb47b36af..dcb056fc2d6 100644 --- a/_generated-doc/main/config/quarkus-mongodb.adoc +++ b/_generated-doc/main/config/quarkus-mongodb.adoc @@ -44,23 +44,6 @@ endif::add-copy-button-to-env-var[] |`false` -a|icon:lock[title=Fixed at build time] [[quarkus-mongodb_quarkus.mongodb.tracing.enabled]]`link:#quarkus-mongodb_quarkus.mongodb.tracing.enabled[quarkus.mongodb.tracing.enabled]` - - -[.description] --- -Whether tracing spans of driver commands are sent in case the smallrye-opentracing extension is present. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_MONGODB_TRACING_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_MONGODB_TRACING_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - a|icon:lock[title=Fixed at build time] [[quarkus-mongodb_quarkus.mongodb.force-default-clients]]`link:#quarkus-mongodb_quarkus.mongodb.force-default-clients[quarkus.mongodb.force-default-clients]` diff --git a/_generated-doc/main/config/quarkus-oidc-general-config-items.adoc b/_generated-doc/main/config/quarkus-oidc-general-config-items.adoc index 4fcfe88d3a6..f55bf3a93e0 100644 --- a/_generated-doc/main/config/quarkus-oidc-general-config-items.adoc +++ b/_generated-doc/main/config/quarkus-oidc-general-config-items.adoc @@ -2372,6 +2372,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-general-config-items_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-general-config-items_quarkus.oidc.provider]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.provider[quarkus.oidc.provider]` @@ -4728,6 +4800,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.provider]]`link:#quarkus-oidc-general-config-items_quarkus.oidc.-tenant-.provider[quarkus.oidc."tenant".provider]` diff --git a/_generated-doc/main/config/quarkus-oidc-oidc-config.adoc b/_generated-doc/main/config/quarkus-oidc-oidc-config.adoc index e5e1eb309c6..af965658ef8 100644 --- a/_generated-doc/main/config/quarkus-oidc-oidc-config.adoc +++ b/_generated-doc/main/config/quarkus-oidc-oidc-config.adoc @@ -2069,6 +2069,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-oidc-config_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-oidc-config_quarkus.oidc.provider]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.provider[quarkus.oidc.provider]` @@ -4408,6 +4480,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.provider]]`link:#quarkus-oidc-oidc-config_quarkus.oidc.-tenant-.provider[quarkus.oidc."tenant".provider]` diff --git a/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config-jwks.adoc b/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config-jwks.adoc new file mode 100644 index 00000000000..a68280d9a68 --- /dev/null +++ b/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config-jwks.adoc @@ -0,0 +1,175 @@ + +:summaryTableId: quarkus-oidc-oidc-tenant-config-jwks +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference, cols="80,.^10,.^10"] +|=== + +h|[[quarkus-oidc-oidc-tenant-config-jwks_configuration]]link:#quarkus-oidc-oidc-tenant-config-jwks_configuration[Configuration property] + +h|Type +h|Default + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-tenant-config-jwks_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + +|=== +ifndef::no-duration-note[] +[NOTE] +[id='duration-note-anchor-{summaryTableId}'] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() javadoc] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] diff --git a/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config.adoc b/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config.adoc index 204eb234798..fc8b206e64c 100644 --- a/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config.adoc +++ b/_generated-doc/main/config/quarkus-oidc-oidc-tenant-config.adoc @@ -2069,6 +2069,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.provider]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.provider[quarkus.oidc.provider]` @@ -4355,6 +4427,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.provider]]`link:#quarkus-oidc-oidc-tenant-config_quarkus.oidc.-tenant-.provider[quarkus.oidc."tenant".provider]` diff --git a/_generated-doc/main/config/quarkus-oidc.adoc b/_generated-doc/main/config/quarkus-oidc.adoc index 2b1bb5816f5..f9ad84f455b 100644 --- a/_generated-doc/main/config/quarkus-oidc.adoc +++ b/_generated-doc/main/config/quarkus-oidc.adoc @@ -2406,6 +2406,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc_quarkus.oidc.jwks.resolve-early]]`link:#quarkus-oidc_quarkus.oidc.jwks.resolve-early[quarkus.oidc.jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.cache-size]]`link:#quarkus-oidc_quarkus.oidc.jwks.cache-size[quarkus.oidc.jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.cache-time-to-live]]`link:#quarkus-oidc_quarkus.oidc.jwks.cache-time-to-live[quarkus.oidc.jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc_quarkus.oidc.jwks.clean-up-timer-interval]]`link:#quarkus-oidc_quarkus.oidc.jwks.clean-up-timer-interval[quarkus.oidc.jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc_quarkus.oidc.provider]]`link:#quarkus-oidc_quarkus.oidc.provider[quarkus.oidc.provider]` @@ -4762,6 +4834,78 @@ endif::add-copy-button-to-env-var[] |`false` +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.resolve-early]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.resolve-early[quarkus.oidc."tenant".jwks.resolve-early]` + + +[.description] +-- +If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized. + +Disabling this property will delay the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-size]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-size[quarkus.oidc."tenant".jwks.cache-size]` + + +[.description] +-- +Maximum number of JWK keys that can be cached. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE+++` +endif::add-copy-button-to-env-var[] +--|int +|`10` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-time-to-live]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.cache-time-to-live[quarkus.oidc."tenant".jwks.cache-time-to-live]` + + +[.description] +-- +Number of minutes a JWK key can be cached for. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +|`10M` + + +a| [[quarkus-oidc_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.jwks.clean-up-timer-interval[quarkus.oidc."tenant".jwks.clean-up-timer-interval]` + + +[.description] +-- +Cache timer interval. If this property is set then a timer will check and remove the stale entries periodically. This property will be ignored if the `resolve-early` property is set to true. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +| + + a| [[quarkus-oidc_quarkus.oidc.-tenant-.provider]]`link:#quarkus-oidc_quarkus.oidc.-tenant-.provider[quarkus.oidc."tenant".provider]` diff --git a/_generated-doc/main/config/quarkus-opentracing-tracing-config.adoc b/_generated-doc/main/config/quarkus-opentracing-tracing-config.adoc deleted file mode 100644 index a4f7e271ef7..00000000000 --- a/_generated-doc/main/config/quarkus-opentracing-tracing-config.adoc +++ /dev/null @@ -1,43 +0,0 @@ - -:summaryTableId: quarkus-opentracing-tracing-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-opentracing-tracing-config_configuration]]link:#quarkus-opentracing-tracing-config_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-opentracing-tracing-config_quarkus.opentracing.server.skip-pattern]]`link:#quarkus-opentracing-tracing-config_quarkus.opentracing.server.skip-pattern[quarkus.opentracing.server.skip-pattern]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-opentracing-tracing-config_quarkus.opentracing.server.operation-name-provider]]`link:#quarkus-opentracing-tracing-config_quarkus.opentracing.server.operation-name-provider[quarkus.opentracing.server.operation-name-provider]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- a| -`http-path`, `class-method` -|`class-method` - -|=== \ No newline at end of file diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-source-reactive-runtime-config.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-source-reactive-runtime-config.adoc index 1236ae7076f..a62830f0449 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-source-reactive-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-source-reactive-runtime-config.adoc @@ -34,7 +34,7 @@ a| [[quarkus-reactive-datasource-config-group-data-source-reactive-runtime-confi -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] @@ -551,7 +551,7 @@ a| [[quarkus-reactive-datasource-config-group-data-source-reactive-runtime-confi -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc index aa9b721c5d6..022d91202e1 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-config-data-source-reactive-outer-named-build-time-config.adoc @@ -51,7 +51,7 @@ a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-build-time-c -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc index 5d068d9f2be..b844859d5e2 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-config-data-source-reactive-outer-named-runtime-config.adoc @@ -34,7 +34,7 @@ a| [[quarkus-reactive-datasource-config-group-data-sources-reactive-runtime-conf -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-reactive-datasource-general-config-items.adoc b/_generated-doc/main/config/quarkus-reactive-datasource-general-config-items.adoc index 06e71820b52..8399dcf95d4 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource-general-config-items.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource-general-config-items.adoc @@ -51,7 +51,7 @@ a| [[quarkus-reactive-datasource-general-config-items_quarkus.datasource.reactiv -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] @@ -590,7 +590,7 @@ a| [[quarkus-reactive-datasource-general-config-items_quarkus.datasource.-dataso -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-reactive-datasource.adoc b/_generated-doc/main/config/quarkus-reactive-datasource.adoc index 5a07428891b..e01c7fa7fde 100644 --- a/_generated-doc/main/config/quarkus-reactive-datasource.adoc +++ b/_generated-doc/main/config/quarkus-reactive-datasource.adoc @@ -51,7 +51,7 @@ a| [[quarkus-reactive-datasource_quarkus.datasource.reactive.url]]`link:#quarkus -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE_REACTIVE_URL+++[] @@ -590,7 +590,7 @@ a| [[quarkus-reactive-datasource_quarkus.datasource.-datasource-name-.reactive.u -- The datasource URLs. -If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses a round-robin load balancing when a connection is created to select different servers. Note: some driver may not support multiple values here. +If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL+++[] diff --git a/_generated-doc/main/config/quarkus-smallrye-opentracing.adoc b/_generated-doc/main/config/quarkus-smallrye-opentracing.adoc deleted file mode 100644 index 1fe1f5100d2..00000000000 --- a/_generated-doc/main/config/quarkus-smallrye-opentracing.adoc +++ /dev/null @@ -1,43 +0,0 @@ - -:summaryTableId: quarkus-smallrye-opentracing -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference.searchable, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-smallrye-opentracing_configuration]]link:#quarkus-smallrye-opentracing_configuration[Configuration property] - -h|Type -h|Default - -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-opentracing_quarkus.opentracing.server.skip-pattern]]`link:#quarkus-smallrye-opentracing_quarkus.opentracing.server.skip-pattern[quarkus.opentracing.server.skip-pattern]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_SKIP_PATTERN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-opentracing_quarkus.opentracing.server.operation-name-provider]]`link:#quarkus-smallrye-opentracing_quarkus.opentracing.server.operation-name-provider[quarkus.opentracing.server.operation-name-provider]` - - -[.description] --- -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_OPENTRACING_SERVER_OPERATION_NAME_PROVIDER+++` -endif::add-copy-button-to-env-var[] --- a| -`http-path`, `class-method` -|`class-method` - -|=== \ No newline at end of file diff --git a/_versions/main/guides/datasource.adoc b/_versions/main/guides/datasource.adoc index 941b1c6200c..5bcd2924568 100644 --- a/_versions/main/guides/datasource.adoc +++ b/_versions/main/guides/datasource.adoc @@ -561,10 +561,11 @@ For more information, see the link:https://db.apache.org/derby/docs/10.8/devguid Example:: `jdbc:h2:tcp://localhost/~/test`, `jdbc:h2:mem:myDB` -H2 is an embedded database that can run as a server, based on a file, or run completely in memory. +H2 is a database that can run in embedded or server mode. +It can use a file storage or run entirely in memory. All of these options are available as listed above. -For more information, see the link:https://h2database.com/html/features.html?highlight=url&search=url#database_url[official documentation]. +For more information, see the link:https://h2database.com/html/features.html#database_url[official documentation]. ==== MariaDB @@ -592,7 +593,7 @@ hostDescription:: `[:] or address=(host=)[(port= quarkus.infinispan-client.username=admin <2> quarkus.infinispan-client.password=password <3> - -quarkus.infinispan-client.client-intelligence=BASIC <4> ---- <1> Sets Infinispan Server address list, separated with commas <2> Sets the authentication username <3> Sets the authentication password -<4> Sets the client intelligence. Use BASIC as a workaround if using Docker for Mac. Alternatively, you can use uri connection by providing a single connection property [source,properties] ---- quarkus.infinispan-client.uri=hotrod://admin:password@localhost:11222 <1> -quarkus.infinispan-client.client-intelligence=BASIC <2> ---- <1> Sets Infinispan URI connection. The following properties will be ignored: hosts, username and password. -<2> Sets the client intelligence. Use BASIC as a workaround if using Docker for Mac [TIP] ==== Use Infinispan Dev Services to run a server and connect without configuration. ==== +=== Client intelligence +Infinispan client uses intelligence mechanisms to efficiently send requests to Infinispan Server clusters. +By default, the *HASH_DISTRIBUTION_AWARE* intelligence mechanism is enabled. +However, locally with Docker for Mac, you might experience connectivity issues. +In this case, configure the client intelligence to *BASIC*. + +Learn more in the https://infinispan.org/docs/stable/titles/hotrod_java/hotrod_java.html#hotrod-client-intelligence_hotrod-java-client[Infinispan documentation]. + +[source,properties] +---- +quarkus.infinispan-client.client-intelligence=BASIC <1> +---- +<1> Docker for Mac workaround. + +[IMPORTANT] +==== +Don't use *BASIC* in production environments by default, performance might be impacted. +==== + === Configuring backup clusters in Cross-Site Replication In High Availability production deployments, it is common to have multiple Infinispan Clusters that are distributed across various Data Centers worldwide. Infinispan offers the capability to connect these clusters and diff --git a/_versions/main/guides/infinispan-client.adoc b/_versions/main/guides/infinispan-client.adoc index 06e08e56242..3e8ccc48ca2 100644 --- a/_versions/main/guides/infinispan-client.adoc +++ b/_versions/main/guides/infinispan-client.adoc @@ -305,14 +305,22 @@ Then, open the `src/main/resources/application.properties` file and add: %prod.quarkus.infinispan-client.username=admin <2> %prod.quarkus.infinispan-client.password=password <3> -## Docker 4 Mac workaround -%prod.quarkus.infinispan-client.client-intelligence=BASIC <4> +## Docker 4 Mac workaround. Uncomment only if you are using Docker for Mac. +## Read more about it in the Infinispan Reference Guide +# %prod.quarkus.infinispan-client.client-intelligence=BASIC <4> ---- <1> Sets Infinispan Server address list, separated with commas <2> Sets the authentication username <3> Sets the authentication password <4> Sets the client intelligence. Use BASIC as a workaround if using Docker for Mac. +[IMPORTANT] +==== +Client intelligence changes impact your performance in production. +Don't change the client intelligence unless strictly necessary for your case. +Read more in the xref:infinispan-client-reference.adoc[Infinispan Client extension reference guide]. +==== + == Packaging and running in JVM mode You can run the application as a conventional jar file. diff --git a/_versions/main/guides/mongodb.adoc b/_versions/main/guides/mongodb.adoc index 92db1a12c15..7d43b58a544 100644 --- a/_versions/main/guides/mongodb.adoc +++ b/_versions/main/guides/mongodb.adoc @@ -616,13 +616,6 @@ This behavior must first be enabled by setting the `quarkus.mongodb.metrics.enab So when you access the `/q/metrics` endpoint of your application you will have information about the connection pool status. When using xref:smallrye-metrics.adoc[SmallRye Metrics], connection pool metrics will be available under the `vendor` scope. -== Tracing - -If you are using the `quarkus-smallrye-opentracing` extension, `quarkus-mongodb-client` can register traces about the commands executed. -This behavior must be enabled by setting the `quarkus.mongodb.tracing.enabled` property to `true` in your `application.properties` and adding the dependency `io.opentracing.contrib:opentracing-mongo-common` to your pom.xml (for more info read the xref:opentracing.adoc#mongodb-client[OpenTracing - MongoDB client] section). - -Read the xref:opentracing.adoc[OpenTracing] guide, for how to configure OpenTracing and how to use the Jaeger tracer. - == Testing helpers xref:#dev-services[Dev Services for MongoDB] is your best option to start a MongoDB database for your unit tests. diff --git a/_versions/main/guides/opentracing.adoc b/_versions/main/guides/opentracing.adoc deleted file mode 100644 index c089dc6847c..00000000000 --- a/_versions/main/guides/opentracing.adoc +++ /dev/null @@ -1,354 +0,0 @@ -//// -This guide is maintained in the main Quarkus repository -and pull requests should be submitted there: -https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc -//// -= Using OpenTracing -:extension-status: deprecated -include::_attributes.adoc[] -:categories: observability -:summary: This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for interactive web applications. -:topics: observability,opentracing -:extensions: io.quarkus:quarkus-smallrye-opentracing - -This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for -interactive web applications. - -[IMPORTANT] -==== -xref:opentelemetry.adoc[OpenTelemetry] is the recommended approach to tracing and telemetry for Quarkus and xref:telemetry-opentracing-to-otel-tutorial.adoc[a guide to help with the migration] is available. - -When Quarkus will upgrade to Eclipse MicroProfile 6, the SmallRye OpenTracing support will be discontinued. -==== - -include::{includes}/extension-status.adoc[] - -== Prerequisites - -:prerequisites-docker: -include::{includes}/prerequisites.adoc[] - -== Architecture - -In this guide, we create a straightforward REST application to demonstrate distributed tracing. - -== Solution - -We recommend that you follow the instructions in the next sections and create the application step by step. -However, you can skip right to the completed example. - -Clone the Git repository: `git clone {quickstarts-clone-url}`, or download an {quickstarts-archive-url}[archive]. - -The solution is located in the `opentracing-quickstart` link:{quickstarts-tree-url}/opentracing-quickstart[directory]. - -== Creating the Maven project - -First, we need a new project. Create a new project with the following command: - -:create-app-artifact-id: opentracing-quickstart -:create-app-extensions: resteasy-reactive,quarkus-smallrye-opentracing -include::{includes}/devtools/create-app.adoc[] - -This command generates the Maven project and imports the `smallrye-opentracing` extension, which -includes the OpenTracing support and the default https://www.jaegertracing.io/[Jaeger] tracer. - -If you already have your Quarkus project configured, you can add the `smallrye-opentracing` extension -to your project by running the following command in your project base directory: - -:add-extension-extensions: smallrye-opentracing -include::{includes}/devtools/extension-add.adoc[] - -This will add the following to your build file: - -[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] -.pom.xml ----- - - io.quarkus - quarkus-smallrye-opentracing - ----- - -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] -.build.gradle ----- -implementation("io.quarkus:quarkus-smallrye-opentracing") ----- - -=== Examine the Jakarta REST resource - -Create the `src/main/java/org/acme/opentracing/TracedResource.java` file with the following content: - -[source,java] ----- -package org.acme.opentracing; - -import jakarta.ws.rs.GET; -import jakarta.ws.rs.Path; -import jakarta.ws.rs.Produces; -import jakarta.ws.rs.core.MediaType; -import org.jboss.logging.Logger; - -@Path("/hello") -public class TracedResource { - - private static final Logger LOG = Logger.getLogger(TracedResource.class); - - @GET - @Produces(MediaType.TEXT_PLAIN) - public String hello() { - LOG.info("hello"); // <1> - return "hello"; - } -} ----- - -<1> The log event carries OpenTracing information as well. In order to print OpenTracing information to the console output, the console log handler with the required OpenTracing event's keys needs to be defined in the `application.properties` file. - -Notice that there is no tracing specific code included in the application. By default, requests sent to this -endpoint will be traced without any code changes being required. It is also possible to enhance the tracing information. -This can be achieved by https://github.com/smallrye/smallrye-opentracing/[SmallRye OpenTracing] an implementation of -https://github.com/eclipse/microprofile-opentracing/[MicroProfile OpenTracing]. - -=== Create the configuration - -There are two ways to configure the Jaeger tracer within the application. - -The first approach is by providing the properties within the `src/main/resources/application.properties` file: - -[source,properties] ----- -quarkus.jaeger.service-name=myservice // <1> -quarkus.jaeger.sampler-type=const // <2> -quarkus.jaeger.sampler-param=1 // <3> -quarkus.log.console.format=%d{HH:mm:ss} %-5p traceId=%X{traceId}, parentId=%X{parentId}, spanId=%X{spanId}, sampled=%X{sampled} [%c{2.}] (%t) %s%e%n // <4> ----- - -<1> If the `quarkus.jaeger.service-name` property (or `JAEGER_SERVICE_NAME` environment variable) is not provided then a "no-op" tracer will be configured, resulting in no tracing data being reported to the backend. -<2> Set up a sampler that uses a constant sampling strategy. -<3> Sample all requests. Set sampler-param to somewhere between 0 and 1, e.g. 0.50, if you do not wish to sample all requests. -<4> Add trace IDs into log message. - -The second approach is to supply the properties as https://www.jaegertracing.io/docs/latest/client-features/[environment variables]. These can be specified using `jvm.args` as shown in the following section. - -== Run the application - -The first step is to start the tracing system to collect and display the captured traces: - -[source,bash] ----- -docker run -p 5775:5775/udp -p 6831:6831/udp -p 6832:6832/udp -p 5778:5778 -p 16686:16686 -p 14268:14268 jaegertracing/all-in-one:latest ----- - -Now we are ready to run our application. If using `application.properties` to configure the tracer: - -include::{includes}/devtools/dev.adoc[] - -or if configuring the tracer via environment variables: - -:dev-additional-parameters: -Djvm.args="-DJAEGER_SERVICE_NAME=myservice -DJAEGER_SAMPLER_TYPE=const -DJAEGER_SAMPLER_PARAM=1" -include::{includes}/devtools/dev.adoc[] -:!dev-additional-parameters: - -Once both the application and tracing system are started, you can make a request to the provided endpoint: - -[source,shell] ----- -$ curl http://localhost:8080/hello -hello ----- -When the first request has been submitted, the Jaeger tracer within the app will be initialized: - -[source] ----- -2019-10-16 09:35:23,464 INFO [io.jae.Configuration] (executor-thread-1) Initialized tracer=JaegerTracer(version=Java-0.34.0, serviceName=myservice, reporter=RemoteReporter(sender=UdpSender(), closeEnqueueTimeout=1000), sampler=ConstSampler(decision=true, tags={sampler.type=const, sampler.param=true}), tags={hostname=localhost.localdomain, jaeger.version=Java-0.34.0, ip=127.0.0.1}, zipkinSharedRpcSpan=false, expandExceptionLogs=false, useTraceId128Bit=false) -13:20:11 INFO traceId=1336b2b0a76a96a3, parentId=0, spanId=1336b2b0a76a96a3, sampled=true [or.ac.qu.TracedResource] (executor-thread-63) hello ----- - -Then visit the http://localhost:16686[Jaeger UI] to see the tracing information. - -Hit `CTRL+C` to stop the application. - -== Tracing additional methods - -REST endpoints are automatically traced. -If you need to trace additional methods, you can add the `org.eclipse.microprofile.opentracing.Traced` annotation to CDI bean classes or their non-private methods. - -This can be useful to trace incoming requests from non-REST calls (like request coming from a message) or to create spans inside a trace. - -Here is an example of a `FrancophoneService` which methods are traced. - -[source, java] ----- -import jakarta.enterprise.context.ApplicationScoped; - -import org.eclipse.microprofile.opentracing.Traced; - -@Traced -@ApplicationScoped -public class FrancophoneService { - - public String bonjour() { - return "bonjour"; - } -} ----- - -NOTE: The best way to add OpenTracing capability to reactive messaging based applications is by adding the `Traced` annotation to all incoming methods. - -== Additional instrumentation - -The https://github.com/opentracing-contrib[OpenTracing API Contributions project] offers additional instrumentation that can be used to add tracing to a large variety of technologies/components. - -The instrumentation documented in this section has been tested with Quarkus and works in both standard and native mode. - -=== JDBC - -The https://github.com/opentracing-contrib/java-jdbc[JDBC instrumentation] will add a span for each JDBC queries done by your application, to enable it, add the following dependency to your build file: - -[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] -.pom.xml ----- - - io.opentracing.contrib - opentracing-jdbc - ----- - -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] -.build.gradle ----- -implementation("io.opentracing.contrib:opentracing-jdbc") ----- - -Then, you need to enable it in the configuration: - -[source, properties] ----- -quarkus.datasource.jdbc.tracing=true ----- - -`quarkus.datasource.jdbc.tracing` is a build time configuration property: -it makes sure all the tracing infrastructure is included in your application. - -[NOTE] -==== -This is especially important when building a native executable as we need to -make sure the OpenTracing JDBC driver has been registered for reflection, -together with the underlying JDBC driver. -==== - -The Agroal extension will take care of adjusting the JDBC URL with the `tracing` prefix -when tracing is enabled, -so you do not have to adjust the JDBC URL yourself. - -By default, when `quarkus.datasource.jdbc.tracing` is true, tracing is enabled at runtime -but you can explicitly disable it by setting the following property: - -[source, properties] ----- -quarkus.datasource.jdbc.tracing.enabled=false ----- - -This way, you can have your Quarkus application ready for tracing and toggle JDBC tracing at runtime. - -=== Kafka - -The https://github.com/opentracing-contrib/java-kafka-client[Kafka instrumentation] will add a span for each message sent to or received from a Kafka topic. To enable it, add the following dependency to your build file: - -[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] -.pom.xml ----- - - io.opentracing.contrib - opentracing-kafka-client - ----- - -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] -.build.gradle ----- -implementation("io.opentracing.contrib:opentracing-kafka-client") ----- - -It contains OpenTracing interceptors that must be registered on Kafka producers and consumers. - -If you followed the xref:kafka.adoc[Kafka guide], the interceptors can be added on the `generated-price` and the `prices` channels as follows: - -[source, properties] ----- -# Configure the Kafka sink (we write to it) -mp.messaging.outgoing.generated-price.connector=smallrye-kafka -mp.messaging.outgoing.generated-price.topic=prices -mp.messaging.outgoing.generated-price.value.serializer=org.apache.kafka.common.serialization.IntegerSerializer -mp.messaging.outgoing.generated-price.interceptor.classes=io.opentracing.contrib.kafka.TracingProducerInterceptor - -# Configure the Kafka source (we read from it) -mp.messaging.incoming.prices.connector=smallrye-kafka -mp.messaging.incoming.prices.value.deserializer=org.apache.kafka.common.serialization.IntegerDeserializer -mp.messaging.incoming.prices.interceptor.classes=io.opentracing.contrib.kafka.TracingConsumerInterceptor ----- - -NOTE: `interceptor.classes` accept a list of classes separated by a comma. - - -=== MongoDB client - -The https://github.com/opentracing-contrib/java-mongo-driver[Mongo Driver instrumentation] will add a span for each command executed by your application. To enable it, add the following dependency to your build file: - -[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] -.pom.xml ----- - - io.opentracing.contrib - opentracing-mongo-common - ----- - -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] -.build.gradle ----- -implementation("io.opentracing.contrib:opentracing-mongo-common") ----- - -It contains the OpenTracing CommandListener that will be registered on the configuration of the mongo client. -Following the xref:mongodb.adoc[MongoDB guide], the command listener will be registered defining the config property as follows: - -[source, properties] ----- -# Enable tracing commands in mongodb client -quarkus.mongodb.tracing.enabled=true ----- - -=== Zipkin compatibility mode - -To enable it, add the following dependency to your build file: - -[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"] -.pom.xml ----- - - io.jaegertracing - jaeger-zipkin - ----- - -[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"] -.build.gradle ----- -implementation("io.jaegertracing:jaeger-zipkin") ----- - -It contains the dependencies to convert the request to zipkin format. -The zipkin compatibility mode will be activated after defining the config property as follows: - -[source, properties] ----- -# Enable zipkin compatibility mode -quarkus.jaeger.zipkin.compatibility-mode=true ----- - -[[configuration-reference]] -== Jaeger Configuration Reference - -include::{generated-dir}/config/quarkus-jaeger.adoc[leveloffset=+1, opts=optional] diff --git a/_versions/main/guides/reaugmentation.adoc b/_versions/main/guides/reaugmentation.adoc index 0c5c976565b..3458f8ffac0 100644 --- a/_versions/main/guides/reaugmentation.adoc +++ b/_versions/main/guides/reaugmentation.adoc @@ -27,7 +27,7 @@ It doesn't matter if you use profiles or any other way to override the propertie == When is re-augmentation useful? Re-augmentation is useful in case the users of your application want to be able to change some of its build time properties. -For instance changing the database driver or switching features on or off (e.g. xref:opentracing.adoc[OpenTracing] or link:{config-consul-guide}[Config Consul]). +For instance changing the database driver or switching features on or off (e.g. xref:opentelemetry.adoc[OpenTelemetry] or link:{config-consul-guide}[Config Consul]). If there are only two or three build time properties that depend on the user environment, you may consider providing alternative builds of the application. However, in case there are more such properties you may prefer shipping a mutable jar instead and let your users re-augment the application for their environment. Please notice that you won't be able to use native images with the package type `mutable-jar`. Think of the consequences and what other options you have! diff --git a/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc b/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc index d1cfa142029..01608b04ff3 100644 --- a/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc +++ b/_versions/main/guides/security-oidc-code-flow-authentication-tutorial.adoc @@ -18,7 +18,7 @@ To learn more about the OIDC authorization code flow mechanism, see xref:securit To learn about how well-known social providers such as Apple, Facebook, GitHub, Google, Mastodon, Microsoft, Twitch, Twitter (X), and Spotify can be used with Quarkus OIDC, see xref:security-openid-connect-providers.adoc[Configuring Well-Known OpenID Connect Providers]. See also, xref:security-authentication-mechanisms.adoc#other-supported-authentication-mechanisms[Authentication mechanisms in Quarkus]. -If you want to protect your service applications by using OIDC Bearer token authentication, see xref:security-oidc-bearer-token-authentication-concept.adoc[OIDC Bearer token authentication]. +If you want to protect your service applications by using OIDC Bearer token authentication, see xref:security-oidc-bearer-token-authentication.adoc[OIDC Bearer token authentication]. == Prerequisites @@ -177,7 +177,7 @@ The `quarkus.oidc.application-type` property is set to `web-app` in order to tel Finally, the `quarkus.http.auth.permission.authenticated` permission is set to tell Quarkus about the paths you want to protect. In this case, all paths are being protected by a policy that ensures that only `authenticated` users are allowed to access. -For more information, see xref:security-authorization-of-web-endpoints-reference.adoc[Security Authorization Guide]. +For more information, see xref:security-authorize-web-endpoints-reference.adoc[Security Authorization Guide]. === Start and configure the Keycloak server @@ -274,4 +274,3 @@ After you have completed this tutorial, explore xref:security-oidc-bearer-token- * xref:security-oidc-auth0-tutorial.adoc[Protect Quarkus web application by using Auth0 OpenID Connect provider] * https://openid.net/connect/[OpenID Connect] * https://tools.ietf.org/html/rfc7519[JSON Web Token] - diff --git a/_versions/main/guides/security-proactive-authentication.adoc b/_versions/main/guides/security-proactive-authentication.adoc index c9dc65fad26..01209ac4905 100644 --- a/_versions/main/guides/security-proactive-authentication.adoc +++ b/_versions/main/guides/security-proactive-authentication.adoc @@ -23,7 +23,7 @@ To disable proactive authentication in Quarkus, set the following attribute in t [source,xml,options="nowrap",role="white-space-pre"] ---- -`quarkus.http.auth.proactive=false` +quarkus.http.auth.proactive=false ---- If you disable proactive authentication, the authentication process runs only when an identity is requested. @@ -42,7 +42,7 @@ You can still access `SecurityIdentity` synchronously with `public SecurityIdent The same is also valid for xref:reactive-routes.adoc[Reactive routes] if a route response is synchronous. ==== -xref:security-authorization.adoc#standard-security-annotations[Standard security annotations] on CDI beans are not supported on an I/O thread if a non-void secured method returns a value synchronously and proactive authentication is disabled because they need to access `SecurityIdentity`. +xref:security-authorize-web-endpoints-reference.adoc#standard-security-annotations[Standard security annotations] on CDI beans are not supported on an I/O thread if a non-void secured method returns a value synchronously and proactive authentication is disabled because they need to access `SecurityIdentity`. In the following example, `HelloResource` and `HelloService` are defined. Any GET request to `/hello` will run on the I/O thread and throw a `BlockingOperationNotAllowedException` exception. diff --git a/_versions/main/guides/telemetry-opentracing-to-otel-tutorial.adoc b/_versions/main/guides/telemetry-opentracing-to-otel-tutorial.adoc index 82eee73801c..c4902124f70 100644 --- a/_versions/main/guides/telemetry-opentracing-to-otel-tutorial.adoc +++ b/_versions/main/guides/telemetry-opentracing-to-otel-tutorial.adoc @@ -11,7 +11,7 @@ include::_attributes.adoc[] :topics: observability,opentracing,opentelemetry,tracing,migration :extensions: io.quarkus:quarkus-smallrye-opentracing,io.quarkus:quarkus-opentelemetry -Migrate an application from xref:opentracing.adoc[OpenTracing] to xref:opentelemetry.adoc[OpenTelemetry tracing] in Quarkus 3.x. +Migrate an application from https://docs.quarkiverse.io/quarkus-smallrye-opentracing/dev/index.html[OpenTracing] to xref:opentelemetry.adoc[OpenTelemetry tracing] in Quarkus 3.x. The legacy OpenTracing framework has been deprecated in favor of the new OpenTelemetry tracing framework. We announced the https://quarkus.io/blog/quarkus-observability-roadmap-2023/#opentracing-archived[OpenTracing deprecation on November 2022], and we are dropping the extension from Quarkus core repository and moving it to the Quarkiverse Hub.