Package io.quarkus.oidc.client.runtime

Interface OidcClientConfig

All Superinterfaces:
OidcClientCommonConfig, OidcCommonConfig
All Known Implementing Classes:
OidcClientConfig
public interface OidcClientConfig extends OidcClientCommonConfig

  • Method Details

    • id

      Optional<String> id()
      A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.

    • clientEnabled

      @WithDefault("true") boolean clientEnabled()
      If this client configuration is enabled.

    • scopes

      Optional<List<String>> scopes()
      List of access token scopes

    • refreshTokenTimeSkew

      Optional<Duration> refreshTokenTimeSkew()
      Refresh token time skew. If this property is enabled then the configured duration is converted to seconds and is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen.

    • accessTokenExpiresIn

      Optional<Duration> accessTokenExpiresIn()
      Access token expiration period relative to the current time. This property is only checked when an access token grant response does not include an access token expiration property.

    • accessTokenExpirySkew

      Optional<Duration> accessTokenExpirySkew()
      Access token expiry time skew that can be added to the calculated token expiry time.

    • absoluteExpiresIn

      @WithDefault("false") boolean absoluteExpiresIn()
      If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.

    • grant

      OidcClientConfig.Grant grant()
      OIDC Client grant config group.

    • grantOptions

      @ConfigDocMapKey("grant-name") Map<String,Map<String,String>> grantOptions()
      Grant options

    • earlyTokensAcquisition

      @WithDefault("true") boolean earlyTokensAcquisition()
      Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.

    • headers

      Map<String,String> headers()
      Custom HTTP headers which have to be sent to the token endpoint

    • builder

      static OidcClientConfigBuilder builder()
      Creates OidcClientConfigBuilder builder populated with documented default values.
      Returns:
      OidcClientConfigBuilder builder

    • builder

      static OidcClientConfigBuilder builder(OidcClientConfig config)
      Creates OidcClientConfigBuilder builder populated with config values.
      Parameters:
      config - client config; must not be null
      Returns:
      OidcClientConfigBuilder

    • authServerUrl

      static OidcClientConfigBuilder authServerUrl(String authServerUrl)
      Creates OidcClientConfigBuilder builder populated with documented default values.
      Parameters:
      authServerUrl - OidcCommonConfig.authServerUrl()
      Returns:
      OidcClientConfigBuilder builder

    • registrationPath

      static OidcClientConfigBuilder registrationPath(String registrationPath)
      Creates OidcClientConfigBuilder builder populated with documented default values.
      Parameters:
      registrationPath - OidcCommonConfig.registrationPath()
      Returns:
      OidcClientConfigBuilder builder

    • tokenPath

      static OidcClientConfigBuilder tokenPath(String tokenPath)
      Creates OidcClientConfigBuilder builder populated with documented default values.
      Parameters:
      tokenPath - OidcClientCommonConfig.tokenPath()
      Returns:
      OidcClientConfigBuilder builder