Package io.quarkiverse.openfga.runtime.config

Interface OpenFGAConfig

@ConfigMapping(prefix="quarkus.openfga") @ConfigRoot(phase=RUN_TIME) public interface OpenFGAConfig

  • Field Details

  • Method Details

    • url

      URL url()
      OpenFGA server URL.

      Example: http://openfga:8080

    • sharedKey

      Optional<String> sharedKey()
      Shared authentication key.

      If none provided unauthenticated access will be attempted.

    • store

      String store()
      Store id or name for default StoreClient bean.

      If the provided property does not match the OpenFGA store id format (^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$) it will be treated as a store name and a matching store id will be resolved at runtime.

      See Also:

    • alwaysResolveStoreId

      @WithDefault("false") boolean alwaysResolveStoreId()
      Always Treat store() as the name of a store and resolve the store id at runtime.

      If true, the store id will always be resolved at runtime regardless of the format of the store() property. Otherwise, the store id will be resolved only when store() does not match the OpenFGA store id format.

      See Also:

    • authorizationModelId

      Optional<String> authorizationModelId()
      Authorization model id for default AuthorizationModelClient bean.

      If none is provided the default bean will target the default authorization model for the store.

    • tlsConfigurationName

      Optional<String> tlsConfigurationName()
      The name of the TLS configuration to use.

      If not set and the default TLS configuration is configured (quarkus.tls.*) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

    • connectTimeout

      @WithDefault("5S") Duration connectTimeout()
      Timeout to establish a connection with OpenFGA.

    • readTimeout

      @WithDefault("5S") Duration readTimeout()
      Request timeout on OpenFGA.

    • nonProxyHosts

      Optional<List<String>> nonProxyHosts()
      List of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose as the JVM nonProxyHosts configuration.

      Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.