io.quarkus.oidc.runtime

Class OidcConfig

java.lang.Object

io.quarkus.oidc.runtime.OidcConfig

@ConfigRoot(phase=RUN_TIME)
public class OidcConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OidcConfig.Authentication Defines the authorization request properties when authenticating users using the Authorization Code Grant Type.
static class	OidcConfig.Credentials
static class	OidcConfig.Roles
static class	OidcConfig.Token

Field Summary

Fields

Modifier and Type	Field and Description
(package private) OidcConfig.Authentication	authentication Different options to configure authorization requests
(package private) String	authServerUrl The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'.
(package private) Optional<String>	clientId The client-id of the application.
Optional<Duration>	connectionDelay The maximum amount of time the adapter will try connecting to the currently unavailable OIDC server for.
(package private) OidcConfig.Credentials	credentials Credentials which the OIDC adapter will use to authenticate to the OIDC server.
(package private) Optional<String>	introspectionPath Relative path of the RFC7662 introspection service.
(package private) Optional<String>	jwksPath Relative path of the OIDC service returning a JWK set.
(package private) Optional<String>	publicKey Public key for the local JWT token verification.
(package private) OidcConfig.Roles	roles Configuration to find and parse a custom claim containing the roles information.
(package private) OidcConfig.Token	token Configuration how to validate the token claims.

Constructor Summary

Constructors

Constructor and Description
OidcConfig()

Method Summary

Modifier and Type	Method and Description
String	getAuthServerUrl()
Optional<String>	getClientId()
OidcConfig.Credentials	getCredentials()
OidcConfig.Roles	getRoles()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authServerUrl

@ConfigItem
String authServerUrl

The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. All the other OIDC server page and service URLs are derived from this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: 'https://host:port/auth/realms/{realm}' where '{realm}' has to be replaced by the name of the Keycloak realm.

introspectionPath

@ConfigItem
Optional<String> introspectionPath

Relative path of the RFC7662 introspection service.

jwksPath

@ConfigItem
Optional<String> jwksPath

Relative path of the OIDC service returning a JWK set.

publicKey

@ConfigItem
Optional<String> publicKey

Public key for the local JWT token verification.

clientId

@ConfigItem
Optional<String> clientId

The client-id of the application. Each application has a client-id that is used to identify the application

connectionDelay

@ConfigItem
public Optional<Duration> connectionDelay

The maximum amount of time the adapter will try connecting to the currently unavailable OIDC server for. For example, setting it to '20S' will let the adapter keep requesting the connection for up to 20 seconds.

roles

@ConfigItem
OidcConfig.Roles roles

Configuration to find and parse a custom claim containing the roles information.

token

@ConfigItem
OidcConfig.Token token

Configuration how to validate the token claims.

credentials

@ConfigItem
OidcConfig.Credentials credentials

Credentials which the OIDC adapter will use to authenticate to the OIDC server.

authentication

OidcConfig.Authentication authentication

Different options to configure authorization requests

Constructor Detail

OidcConfig

public OidcConfig()

Method Detail

getAuthServerUrl

public String getAuthServerUrl()

getClientId

public Optional<String> getClientId()

getCredentials

public OidcConfig.Credentials getCredentials()

getRoles

public OidcConfig.Roles getRoles()