Package io.quarkus.oidc.runtime

Interface OidcTenantConfig.Backchannel

All Known Implementing Classes:
OidcTenantConfig.Backchannel
Enclosing interface:
OidcTenantConfig
public static interface OidcTenantConfig.Backchannel

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Duration>
    cleanUpTimerInterval()
    Token cache timer interval.
    String
    logoutTokenKey()
    Logout token claim whose value is used as a key for caching the tokens.
    Optional<String>
    path()
    The relative path of the Back-Channel Logout endpoint at the application.
    int
    tokenCacheSize()
    Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
    Duration
    tokenCacheTimeToLive()
    Number of minutes a logout token can be cached for.

  • Method Details

    • path

      Optional<String> path()
      The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.

    • tokenCacheSize

      @WithDefault("10") int tokenCacheSize()
      Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.

    • tokenCacheTimeToLive

      @WithDefault("10M") Duration tokenCacheTimeToLive()
      Number of minutes a logout token can be cached for.

    • cleanUpTimerInterval

      Optional<Duration> cleanUpTimerInterval()
      Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.

    • logoutTokenKey

      @WithDefault("sub") String logoutTokenKey()
      Logout token claim whose value is 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.