OidcTenantConfig (Quarkus - OpenID Connect Adapter

java.lang.Object
- io.quarkus.oidc.runtime.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.Proxy`
`static class`	`OidcTenantConfig.Roles`
`static class`	`OidcTenantConfig.Tls`
`static class`	`OidcTenantConfig.Token`

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`.
`(package private) OidcTenantConfig.Authentication`	`authentication` Different options to configure authorization requests
`(package private) Optional<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) OidcTenantConfig.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) OidcTenantConfig.Proxy`	`proxy` Options to configure a proxy that OIDC adapter will use for talking with OIDC server.
`(package private) Optional<String>`	`publicKey` Public key for the local JWT token verification.
`(package private) OidcTenantConfig.Roles`	`roles` Configuration to find and parse a custom claim containing the roles information.
`boolean`	`tenantEnabled` If this tenant configuration is enabled.
`(package private) Optional<String>`	`tenantId` A unique tenant identifier.
`(package private) OidcTenantConfig.Tls`	`tls` TLS configurations
`(package private) OidcTenantConfig.Token`	`token` Configuration how to validate the token claims.

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.Authentication`	`getAuthentication()`
`Optional<String>`	`getAuthServerUrl()`
`Optional<String>`	`getClientId()`
`Optional<Duration>`	`getConnectionDelay()`
`OidcTenantConfig.Credentials`	`getCredentials()`
`Optional<String>`	`getIntrospectionPath()`
`Optional<String>`	`getJwksPath()`
`OidcTenantConfig.Proxy`	`getProxy()`
`Optional<String>`	`getPublicKey()`
`OidcTenantConfig.Roles`	`getRoles()`
`Optional<String>`	`getTenantId()`
`OidcTenantConfig.Token`	`getToken()`
`void`	`setAuthentication(OidcTenantConfig.Authentication authentication)`
`void`	`setAuthServerUrl(String authServerUrl)`
`void`	`setClientId(String clientId)`
`void`	`setConnectionDelay(Duration connectionDelay)`
`void`	`setCredentials(OidcTenantConfig.Credentials credentials)`
`void`	`setIntrospectionPath(String introspectionPath)`
`void`	`setJwksPath(String jwksPath)`
`void`	`setProxy(OidcTenantConfig.Proxy proxy)`
`void`	`setPublicKey(String publicKey)`
`void`	`setRoles(OidcTenantConfig.Roles roles)`
`void`	`setTenantId(String tenantId)`
`void`	`setToken(OidcTenantConfig.Token token)`

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

- Field Detail
  - tenantId
```
@ConfigItem
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.
  - 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.
  - authServerUrl
```
@ConfigItem
Optional<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
  - roles
```
@ConfigItem
OidcTenantConfig.Roles roles
```
    Configuration to find and parse a custom claim containing the roles information.
  - token
```
@ConfigItem
OidcTenantConfig.Token token
```
    Configuration how to validate the token claims.
  - credentials
```
@ConfigItem
OidcTenantConfig.Credentials credentials
```
    Credentials which the OIDC adapter will use to authenticate to the OIDC server.
  - proxy
```
@ConfigItem
OidcTenantConfig.Proxy proxy
```
    Options to configure a proxy that OIDC adapter will use for talking with OIDC server.
  - authentication
```
OidcTenantConfig.Authentication authentication
```
    Different options to configure authorization requests
  - tls
```
@ConfigItem
OidcTenantConfig.Tls tls
```
    TLS configurations
- 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)
```
  - getIntrospectionPath
```
public Optional<String> getIntrospectionPath()
```
  - setIntrospectionPath
```
public void setIntrospectionPath(String introspectionPath)
```
  - getJwksPath
```
public Optional<String> getJwksPath()
```
  - setJwksPath
```
public void setJwksPath(String jwksPath)
```
  - 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)
```
  - getProxy
```
public OidcTenantConfig.Proxy getProxy()
```
  - setProxy
```
public void setProxy(OidcTenantConfig.Proxy proxy)
```

Class OidcTenantConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tenantId

tenantEnabled

applicationType

connectionDelay

authServerUrl

introspectionPath

jwksPath

publicKey

clientId

roles

token

credentials

proxy

authentication

tls

Constructor Detail

OidcTenantConfig

Method Detail

getConnectionDelay

setConnectionDelay

getAuthServerUrl

setAuthServerUrl

getIntrospectionPath

setIntrospectionPath

getJwksPath

setJwksPath

getPublicKey

setPublicKey

getClientId

setClientId

getRoles

setRoles

getToken

setToken

getCredentials

setCredentials

getAuthentication

setAuthentication

getTenantId

setTenantId

getProxy

setProxy