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

Interface OidcClientCommonConfig

All Superinterfaces:

OidcCommonConfig

All Known Implementing Classes:

OidcClientCommonConfig, OidcClientCommonConfigBuilder.OidcClientCommonConfigImpl

public interface OidcClientCommonConfig
extends OidcCommonConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OidcClientCommonConfig.Credentials	Credentials used by OIDC client to authenticate to OIDC token and other secured endpoints.

Nested classes/interfaces inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig

OidcCommonConfig.Proxy, OidcCommonConfig.Tls

Method Summary

Modifier and Type	Method	Description
Optional<String>	clientId()	The client id of the application.
Optional<String>	clientName()	The client name of the application.
OidcClientCommonConfig.Credentials	credentials()	Different authentication options for OIDC client to access OIDC token and other secured endpoints.
Optional<String>	revokePath()	The relative path or absolute URL of the OIDC token revocation endpoint.
Optional<String>	tokenPath()	The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL.

Methods inherited from interface io.quarkus.oidc.common.runtime.config.OidcCommonConfig

authServerUrl, connectionDelay, connectionRetryCount, connectionTimeout, discoveryEnabled, followRedirects, maxPoolSize, proxy, registrationPath, tls, useBlockingDnsLookup

Method Details

tokenPath

Optional<String> tokenPath()

The OIDC token endpoint that issues access and refresh tokens; specified as a relative path or absolute URL. Set if OidcCommonConfig.discoveryEnabled() is `false` or a discovered token endpoint path must be customized.

revokePath

Optional<String> revokePath()

The relative path or absolute URL of the OIDC token revocation endpoint.

clientId

Optional<String> clientId()

The client id of the application. Each application has a client id that is used to identify the application. Setting the client id is not required if

invalid reference

#applicationType

is `service` and no token introspection is required.

clientName

Optional<String> clientName()

The client name of the application. It is meant to represent a human readable description of the application which you may provide when an application (client) is registered in an OpenId Connect provider's dashboard. For example, you can set this property to have more informative log messages which record an activity of the given client.

credentials

@ConfigDocSection
OidcClientCommonConfig.Credentials credentials()

Different authentication options for OIDC client to access OIDC token and other secured endpoints.