Package io.quarkus.oidc.common.runtime.config

Interface OidcCommonConfig

All Known Subinterfaces:
OidcClientCommonConfig
All Known Implementing Classes:
OidcClientCommonConfig, OidcClientCommonConfigBuilder.OidcClientCommonConfigImpl, OidcCommonConfig, OidcCommonConfigBuilder.OidcCommonConfigImpl
public interface OidcCommonConfig

  • Method Details

    • authServerUrl

      Optional<String> authServerUrl()
      The base URL of the OpenID Connect (OIDC) server, for example, `https://host:port/auth`. Do not set this property if you use 'quarkus-oidc' and the public key verification (
      invalid reference 
      #publicKey
      ) or certificate chain verification only (
      invalid reference 
      #certificateChain
      ) is required. The OIDC discovery endpoint is called by default by appending a `.well-known/openid-configuration` path to this URL. For Keycloak, use `https://host:port/realms/{realm}`, replacing `{realm}` with the Keycloak realm name.

    • discoveryEnabled

      @ConfigDocDefault("true") Optional<Boolean> discoveryEnabled()
      Discovery of the OIDC endpoints. If not enabled, you must configure the OIDC endpoint URLs individually.

    • registrationPath

      Optional<String> registrationPath()
      The relative path or absolute URL of the OIDC dynamic client registration endpoint. Set if discoveryEnabled() is `false` or a discovered token endpoint path must be customized.

    • connectionDelay

      Optional<Duration> connectionDelay()
      The duration to attempt the initial connection to an OIDC server. For example, setting the duration to `20S` allows 10 retries, each 2 seconds apart. This property is only effective when the initial OIDC connection is created. For dropped connections, use the `connection-retry-count` property instead.

    • connectionRetryCount

      @WithDefault("3") int connectionRetryCount()
      The number of times to retry re-establishing an existing OIDC connection if it is temporarily lost. Different from `connection-delay`, which applies only to initial connection attempts. For instance, if a request to the OIDC token endpoint fails due to a connection issue, it will be retried as per this setting.

    • connectionTimeout

      @WithDefault("10s") Duration connectionTimeout()
      The number of seconds after which the current OIDC connection request times out.

    • useBlockingDnsLookup

      @WithDefault("false") boolean useBlockingDnsLookup()
      Whether DNS lookup should be performed on the worker thread. Use this option when you can see logged warnings about blocked Vert.x event loop by HTTP requests to OIDC server.

    • maxPoolSize

      OptionalInt maxPoolSize()
      The maximum size of the connection pool used by the WebClient.

    • followRedirects

      @WithDefault("true") boolean followRedirects()
      Follow redirects automatically when WebClient gets HTTP 302. When this property is disabled only a single redirect to exactly the same original URI is allowed but only if one or more cookies were set during the redirect request.

    • proxy

      @ConfigDocSection OidcCommonConfig.Proxy proxy()
      HTTP proxy configuration.

    • tls

      @ConfigDocSection OidcCommonConfig.Tls tls()
      TLS configuration.