OidcTenantConfig (Quarkus - OpenID Connect Adapter

java.lang.Object
- io.quarkus.oidc.OidcTenantConfig

public class OidcTenantConfig
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`OidcTenantConfig.ApplicationType`
`static class`	`OidcTenantConfig.Authentication` Defines the authorization request properties when authenticating users using the Authorization Code Grant Type.
`static class`	`OidcTenantConfig.Credentials`
`static class`	`OidcTenantConfig.Logout`
`static class`	`OidcTenantConfig.Proxy`
`static class`	`OidcTenantConfig.Roles`
`static class`	`OidcTenantConfig.Tls`
`static class`	`OidcTenantConfig.Token`
`static class`	`OidcTenantConfig.TokenStateManager` Default Authorization Code token state manager configuration

Field Summary

Fields
Modifier and Type	Field and Description
`OidcTenantConfig.ApplicationType`	`applicationType` The application type, which can be one of the following values from enum `OidcTenantConfig.ApplicationType`.
`OidcTenantConfig.Authentication`	`authentication` Different options to configure authorization requests
`Optional<String>`	`authorizationPath` Relative path of the OIDC authorization endpoint which authenticates the users.
`Optional<String>`	`authServerUrl` The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'.
`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.
`OidcTenantConfig.Credentials`	`credentials` Credentials which the OIDC adapter will use to authenticate to the OIDC server.
`boolean`	`discoveryEnabled` Enables OIDC discovery.
`Optional<String>`	`endSessionPath` Relative path of the OIDC end_session_endpoint.
`Optional<String>`	`introspectionPath` Relative path of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens.
`Optional<String>`	`jwksPath` Relative path of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set.
`OidcTenantConfig.Logout`	`logout` Logout configuration
`OidcTenantConfig.Proxy`	`proxy` Options to configure a proxy that OIDC adapter will use for talking with OIDC server.
`Optional<String>`	`publicKey` Public key for the local JWT token verification.
`OidcTenantConfig.Roles`	`roles` Configuration to find and parse a custom claim containing the roles information.
`boolean`	`tenantEnabled` If this tenant configuration is enabled.
`Optional<String>`	`tenantId` A unique tenant identifier.
`OidcTenantConfig.Tls`	`tls` TLS configurations
`OidcTenantConfig.Token`	`token` Configuration how to validate the token claims.
`Optional<String>`	`tokenPath` Relative path of the OIDC token endpoint which issues ID, access and refresh tokens.
`OidcTenantConfig.TokenStateManager`	`tokenStateManager` Default token state manager configuration
`Optional<String>`	`userInfoPath` Relative path of the OIDC userinfo endpoint.

Constructor Summary

Constructors
Constructor and Description

OidcTenantConfig()

Constructors
Constructor and Description
`OidcTenantConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OidcTenantConfig.ApplicationType`	`getApplicationType()`
`OidcTenantConfig.Authentication`	`getAuthentication()`
`Optional<String>`	`getAuthorizationPath()`
`Optional<String>`	`getAuthServerUrl()`
`Optional<String>`	`getClientId()`
`Optional<Duration>`	`getConnectionDelay()`
`OidcTenantConfig.Credentials`	`getCredentials()`
`Optional<String>`	`getEndSessionPath()`
`Optional<String>`	`getIntrospectionPath()`
`Optional<String>`	`getJwksPath()`
`OidcTenantConfig.Logout`	`getLogout()`
`OidcTenantConfig.Proxy`	`getProxy()`
`Optional<String>`	`getPublicKey()`
`OidcTenantConfig.Roles`	`getRoles()`
`Optional<String>`	`getTenantId()`
`OidcTenantConfig.Token`	`getToken()`
`Optional<String>`	`getTokenPath()`
`Optional<String>`	`getUserInfoPath()`
`boolean`	`isDiscoveryEnabled()`
`boolean`	`isTenantEnabled()`
`void`	`setApplicationType(OidcTenantConfig.ApplicationType type)`
`void`	`setAuthentication(OidcTenantConfig.Authentication authentication)`
`void`	`setAuthorizationPath(String authorizationPath)`
`void`	`setAuthServerUrl(String authServerUrl)`
`void`	`setClientId(String clientId)`
`void`	`setConnectionDelay(Duration connectionDelay)`
`void`	`setCredentials(OidcTenantConfig.Credentials credentials)`
`void`	`setDiscoveryEnabled(boolean enabled)`
`void`	`setEndSessionPath(String endSessionPath)`
`void`	`setIntrospectionPath(String introspectionPath)`
`void`	`setJwksPath(String jwksPath)`
`void`	`setLogout(OidcTenantConfig.Logout logout)`
`void`	`setProxy(OidcTenantConfig.Proxy proxy)`
`void`	`setPublicKey(String publicKey)`
`void`	`setRoles(OidcTenantConfig.Roles roles)`
`void`	`setTenantEnabled(boolean enabled)`
`void`	`setTenantId(String tenantId)`
`void`	`setToken(OidcTenantConfig.Token token)`
`void`	`setTokenPath(String tokenPath)`
`void`	`setUserInfoPath(String userInfoPath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tenantId
```
@ConfigItem
public Optional<String> tenantId
```
    A unique tenant identifier. It must be set by TenantConfigResolver providers which resolve the tenant configuration dynamically and is optional in all other cases.
  - tenantEnabled
```
@ConfigItem(defaultValue="true")
public boolean tenantEnabled
```
    If this tenant configuration is enabled.
  - applicationType
```
@ConfigItem(defaultValue="service")
public OidcTenantConfig.ApplicationType applicationType
```
    The application type, which can be one of the following values from enum OidcTenantConfig.ApplicationType.
  - authServerUrl
```
@ConfigItem
public Optional<String> authServerUrl
```
    The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to 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.
  - discoveryEnabled
```
@ConfigItem(defaultValue="true")
public boolean discoveryEnabled
```
    Enables OIDC discovery. If the discovery is disabled then the following properties must be configured: - 'authorization-path' and 'token-path' for the 'web-app' applications - 'jwks-path' or 'introspection-path' for both the 'web-app' and 'service' applications
    'web-app' applications may also have 'user-info-path' and 'end-session-path' properties configured.
  - authorizationPath
```
@ConfigItem
public Optional<String> authorizationPath
```
    Relative path of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.
  - tokenPath
```
@ConfigItem
public Optional<String> tokenPath
```
    Relative path of the OIDC token endpoint which issues ID, access and refresh tokens. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled.
  - userInfoPath
```
@ConfigItem
public Optional<String> userInfoPath
```
    Relative path of the OIDC userinfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and 'authentication.user-info-required' property is enabled. This property will be ignored if the discovery is enabled.
  - introspectionPath
```
@ConfigItem
public Optional<String> introspectionPath
```
    Relative path of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled.
  - jwksPath
```
@ConfigItem
public Optional<String> jwksPath
```
    Relative path of the OIDC JWKS endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property will be ignored if the discovery is enabled.
  - endSessionPath
```
@ConfigItem
public Optional<String> endSessionPath
```
    Relative path of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the 'web-app' applications is required. This property will be ignored if the discovery is enabled.
  - 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.
  - publicKey
```
@ConfigItem
public Optional<String> publicKey
```
    Public key for the local JWT token verification. OIDC server connection will not be created when this property is set.
  - clientId
```
@ConfigItem
public Optional<String> clientId
```
    The client-id of the application. Each application has a client-id that is used to identify the application
  - roles
```
@ConfigItem
public OidcTenantConfig.Roles roles
```
    Configuration to find and parse a custom claim containing the roles information.
  - token
```
@ConfigItem
public OidcTenantConfig.Token token
```
    Configuration how to validate the token claims.
  - credentials
```
@ConfigItem
public OidcTenantConfig.Credentials credentials
```
    Credentials which the OIDC adapter will use to authenticate to the OIDC server.
  - proxy
```
@ConfigItem
public OidcTenantConfig.Proxy proxy
```
    Options to configure a proxy that OIDC adapter will use for talking with OIDC server.
  - authentication
```
public OidcTenantConfig.Authentication authentication
```
    Different options to configure authorization requests
  - tls
```
@ConfigItem
public OidcTenantConfig.Tls tls
```
    TLS configurations
  - logout
```
@ConfigItem
public OidcTenantConfig.Logout logout
```
    Logout configuration
  - tokenStateManager
```
@ConfigItem
public OidcTenantConfig.TokenStateManager tokenStateManager
```
    Default token state manager configuration
- Constructor Detail
  - OidcTenantConfig
```
public OidcTenantConfig()
```
- Method Detail
  - getConnectionDelay
```
public Optional<Duration> getConnectionDelay()
```
  - setConnectionDelay
```
public void setConnectionDelay(Duration connectionDelay)
```
  - getAuthServerUrl
```
public Optional<String> getAuthServerUrl()
```
  - setAuthServerUrl
```
public void setAuthServerUrl(String authServerUrl)
```
  - getAuthorizationPath
```
public Optional<String> getAuthorizationPath()
```
  - setAuthorizationPath
```
public void setAuthorizationPath(String authorizationPath)
```
  - getTokenPath
```
public Optional<String> getTokenPath()
```
  - setTokenPath
```
public void setTokenPath(String tokenPath)
```
  - getUserInfoPath
```
public Optional<String> getUserInfoPath()
```
  - setUserInfoPath
```
public void setUserInfoPath(String userInfoPath)
```
  - getIntrospectionPath
```
public Optional<String> getIntrospectionPath()
```
  - setIntrospectionPath
```
public void setIntrospectionPath(String introspectionPath)
```
  - getJwksPath
```
public Optional<String> getJwksPath()
```
  - setJwksPath
```
public void setJwksPath(String jwksPath)
```
  - getEndSessionPath
```
public Optional<String> getEndSessionPath()
```
  - setEndSessionPath
```
public void setEndSessionPath(String endSessionPath)
```
  - getPublicKey
```
public Optional<String> getPublicKey()
```
  - setPublicKey
```
public void setPublicKey(String publicKey)
```
  - getClientId
```
public Optional<String> getClientId()
```
  - setClientId
```
public void setClientId(String clientId)
```
  - getRoles
```
public OidcTenantConfig.Roles getRoles()
```
  - setRoles
```
public void setRoles(OidcTenantConfig.Roles roles)
```
  - getToken
```
public OidcTenantConfig.Token getToken()
```
  - setToken
```
public void setToken(OidcTenantConfig.Token token)
```
  - getCredentials
```
public OidcTenantConfig.Credentials getCredentials()
```
  - setCredentials
```
public void setCredentials(OidcTenantConfig.Credentials credentials)
```
  - getAuthentication
```
public OidcTenantConfig.Authentication getAuthentication()
```
  - setAuthentication
```
public void setAuthentication(OidcTenantConfig.Authentication authentication)
```
  - getTenantId
```
public Optional<String> getTenantId()
```
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - isTenantEnabled
```
public boolean isTenantEnabled()
```
  - setTenantEnabled
```
public void setTenantEnabled(boolean enabled)
```
  - isDiscoveryEnabled
```
public boolean isDiscoveryEnabled()
```
  - setDiscoveryEnabled
```
public void setDiscoveryEnabled(boolean enabled)
```
  - getProxy
```
public OidcTenantConfig.Proxy getProxy()
```
  - setProxy
```
public void setProxy(OidcTenantConfig.Proxy proxy)
```
  - setLogout
```
public void setLogout(OidcTenantConfig.Logout logout)
```
  - getLogout
```
public OidcTenantConfig.Logout getLogout()
```
  - getApplicationType
```
public OidcTenantConfig.ApplicationType getApplicationType()
```
  - setApplicationType
```
public void setApplicationType(OidcTenantConfig.ApplicationType type)
```

Class OidcTenantConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tenantId

tenantEnabled

applicationType

authServerUrl

discoveryEnabled

authorizationPath

tokenPath

userInfoPath

introspectionPath

jwksPath

endSessionPath

connectionDelay

publicKey

clientId

roles

token

credentials

proxy

authentication

tls

logout

tokenStateManager

Constructor Detail

OidcTenantConfig

Method Detail

getConnectionDelay

setConnectionDelay

getAuthServerUrl

setAuthServerUrl

getAuthorizationPath

setAuthorizationPath

getTokenPath

setTokenPath

getUserInfoPath

setUserInfoPath

getIntrospectionPath

setIntrospectionPath

getJwksPath

setJwksPath

getEndSessionPath

setEndSessionPath

getPublicKey

setPublicKey

getClientId

setClientId

getRoles

setRoles

getToken

setToken

getCredentials

setCredentials

getAuthentication

setAuthentication

getTenantId

setTenantId

isTenantEnabled

setTenantEnabled

isDiscoveryEnabled

setDiscoveryEnabled

getProxy

setProxy

setLogout

getLogout

getApplicationType

setApplicationType