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

Enclosing class:

OidcTenantConfig
```
public static class OidcTenantConfig.Authentication
extends Object
```
Defines the authorization request properties when authenticating users using the Authorization Code Grant Type.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OidcTenantConfig.Authentication.CookieSameSite`	SameSite attribute values for the session cookie.
`static class`	`OidcTenantConfig.Authentication.ResponseMode`	Authorization code flow response mode

Field Summary

Fields
Modifier and Type	Field	Description
`Optional<Boolean>`	`addOpenidScope`	Add the 'openid' scope automatically to the list of scopes.
`boolean`	`allowMultipleCodeFlows`	If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path.
`Optional<String>`	`cookieDomain`	Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.
`boolean`	`cookieForceSecure`	If enabled the state, session and post logout cookies will have their 'secure' parameter set to 'true' when HTTP is used.
`String`	`cookiePath`	Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies.
`Optional<String>`	`cookiePathHeader`	Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies.
`OidcTenantConfig.Authentication.CookieSameSite`	`cookieSameSite`	SameSite attribute for the session cookie.
`Optional<String>`	`cookieSuffix`	Cookie name suffix.
`Optional<String>`	`errorPath`	Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint.
`Map<String,String>`	`extraParams`	Additional properties which will be added as the query parameters to the authentication redirect URI.
`Optional<Boolean>`	`forceRedirectHttpsScheme`	Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy.
`Optional<List<String>>`	`forwardParams`	Request URL query parameters which, if present, will be added to the authentication redirect URI.
`Optional<Boolean>`	`idTokenRequired`	Requires that ID token is available when the authorization code flow completes.
`Optional<Duration>`	`internalIdTokenLifespan`	Internal ID token lifespan.
`boolean`	`javaScriptAutoRedirect`	If this property is set to 'true' then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single Page Applications since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS.
`Optional<Boolean>`	`pkceRequired`	Requires that a Proof Key for Code Exchange (PKCE) is used.
`Optional<String>`	`pkceSecret`	Secret which will be used to encrypt a Proof Key for Code Exchange (PKCE) code verifier in the code flow state.
`Optional<String>`	`redirectPath`	Relative path for calculating a "redirect_uri" query parameter.
`boolean`	`removeRedirectParameters`	Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.
`Optional<OidcTenantConfig.Authentication.ResponseMode>`	`responseMode`	Authorization code flow response mode
`boolean`	`restorePathAfterRedirect`	If this property is set to 'true' then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application.
`Optional<List<String>>`	`scopes`	List of scopes
`Duration`	`sessionAgeExtension`	Session age extension in minutes.
`Optional<Boolean>`	`userInfoRequired`	If this property is set to 'true' then an OIDC UserInfo endpoint will be called.
`boolean`	`verifyAccessToken`	Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.

Constructor Summary

Constructors
Constructor Description

Authentication()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<String>`	`getCookieDomain()`
`String`	`getCookiePath()`
`Optional<String>`	`getCookiePathHeader()`
`OidcTenantConfig.Authentication.CookieSameSite`	`getCookieSameSite()`
`Optional<String>`	`getCookieSuffix()`
`Optional<String>`	`getErrorPath()`
`Map<String,String>`	`getExtraParams()`
`Optional<List<String>>`	`getForwardParams()`
`Optional<Duration>`	`getInternalIdTokenLifespan()`
`Optional<String>`	`getPkceSecret()`
`Optional<String>`	`getRedirectPath()`
`Optional<OidcTenantConfig.Authentication.ResponseMode>`	`getResponseMode()`
`Optional<List<String>>`	`getScopes()`
`Duration`	`getSessionAgeExtension()`
`Optional<Boolean>`	`isAddOpenidScope()`
`boolean`	`isAllowMultipleCodeFlows()`
`boolean`	`isCookieForceSecure()`
`Optional<Boolean>`	`isForceRedirectHttpsScheme()`
`Optional<Boolean>`	`isIdTokenRequired()`
`boolean`	`isJavaScriptAutoRedirect()`
`Optional<Boolean>`	`isPkceRequired()`
`boolean`	`isRemoveRedirectParameters()`
`boolean`	`isRestorePathAfterRedirect()`
`Optional<Boolean>`	`isUserInfoRequired()`
`boolean`	`isVerifyAccessToken()`
`void`	`setAddOpenidScope(boolean addOpenidScope)`
`void`	`setAllowMultipleCodeFlows(boolean allowMultipleCodeFlows)`
`void`	`setCookieDomain(String cookieDomain)`
`void`	`setCookieForceSecure(boolean cookieForceSecure)`
`void`	`setCookiePath(String cookiePath)`
`void`	`setCookiePathHeader(String cookiePathHeader)`
`void`	`setCookieSameSite(OidcTenantConfig.Authentication.CookieSameSite cookieSameSite)`
`void`	`setCookieSuffix(String cookieSuffix)`
`void`	`setErrorPath(String errorPath)`
`void`	`setExtraParams(Map<String,String> extraParams)`
`void`	`setForceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)`
`void`	`setForwardParams(List<String> forwardParams)`
`void`	`setIdTokenRequired(boolean idTokenRequired)`
`void`	`setInternalIdTokenLifespan(Duration internalIdTokenLifespan)`
`void`	`setJavaScriptAutoredirect(boolean autoRedirect)`
`void`	`setPkceRequired(boolean pkceRequired)`
`void`	`setPkceSecret(String pkceSecret)`
`void`	`setRedirectPath(String redirectPath)`
`void`	`setRemoveRedirectParameters(boolean removeRedirectParameters)`
`void`	`setResponseMode(OidcTenantConfig.Authentication.ResponseMode responseMode)`
`void`	`setRestorePathAfterRedirect(boolean restorePathAfterRedirect)`
`void`	`setScopes(List<String> scopes)`
`void`	`setSessionAgeExtension(Duration sessionAgeExtension)`
`void`	`setUserInfoRequired(boolean userInfoRequired)`
`void`	`setVerifyAccessToken(boolean verifyAccessToken)`

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

- Field Detail
  - responseMode
```
@ConfigItem(defaultValueDocumentation="query")
public Optional<OidcTenantConfig.Authentication.ResponseMode> responseMode
```
    Authorization code flow response mode
  - redirectPath
```
@ConfigItem
public Optional<String> redirectPath
```
    Relative path for calculating a "redirect_uri" query parameter. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if the current request URI is 'https://localhost:8080/service' then a 'redirect_uri' parameter will be set to 'https://localhost:8080/' if this property is set to '/' and be the same as the request URI if this property has not been configured. Note the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to 'true'.
  - restorePathAfterRedirect
```
@ConfigItem(defaultValue="false")
public boolean restorePathAfterRedirect
```
    If this property is set to 'true' then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if `redirectPath` property is not set, the original request URI will be restored even if this property is disabled.
  - removeRedirectParameters
```
@ConfigItem(defaultValue="true")
public boolean removeRedirectParameters
```
    Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.
  - errorPath
```
@ConfigItem
public Optional<String> errorPath
```
    Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an 'error' and an optional 'error_description' parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be appended to the request URI's host and port. For example, if it is set as '/error' and the current request URI is 'https://localhost:8080/callback?error=invalid_scope' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure.
  - verifyAccessToken
```
@ConfigItem(defaultValue="false")
public boolean verifyAccessToken
```
    Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow. ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source` property is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the access token. Bearer access tokens are always verified.
  - forceRedirectHttpsScheme
```
@ConfigItem(defaultValueDocumentation="false")
public Optional<Boolean> forceRedirectHttpsScheme
```
    Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy. This property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.
  - scopes
```
@ConfigItem
public Optional<List<String>> scopes
```
    List of scopes
  - addOpenidScope
```
@ConfigItem(defaultValueDocumentation="true")
public Optional<Boolean> addOpenidScope
```
    Add the 'openid' scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.
  - extraParams
```
@ConfigItem
public Map<String,String> extraParams
```
    Additional properties which will be added as the query parameters to the authentication redirect URI.
  - forwardParams
```
@ConfigItem
@ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
public Optional<List<String>> forwardParams
```
    Request URL query parameters which, if present, will be added to the authentication redirect URI.
  - cookieForceSecure
```
@ConfigItem(defaultValue="false")
public boolean cookieForceSecure
```
    If enabled the state, session and post logout cookies will have their 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false.
  - cookieSuffix
```
@ConfigItem
public Optional<String> cookieSuffix
```
    Cookie name suffix. For example, a session cookie name for the default OIDC tenant is 'q_session' but can be changed to 'q_session_test' if this property is set to 'test'.
  - cookiePath
```
@ConfigItem(defaultValue="/")
public String cookiePath
```
    Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The `cookie-path-header` property, if set, will be checked first.
  - cookiePathHeader
```
@ConfigItem
public Optional<String> cookiePathHeader
```
    Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the `cookie-path` property will be checked.
  - cookieDomain
```
@ConfigItem
public Optional<String> cookieDomain
```
    Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.
  - cookieSameSite
```
@ConfigItem(defaultValue="lax")
public OidcTenantConfig.Authentication.CookieSameSite cookieSameSite
```
    SameSite attribute for the session cookie.
  - allowMultipleCodeFlows
```
@ConfigItem(defaultValue="true")
public boolean allowMultipleCodeFlows
```
    If a state cookie is present then a `state` query parameter must also be present and both the state cookie name suffix and state cookie value have to match the value of the `state` query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie may represent the authentication flow initiated from another tab and not related to the current request. Disable this property if you would like to avoid supporting multiple authorization code flows running in the same browser.
  - userInfoRequired
```
@ConfigItem(defaultValueDocumentation="false")
public Optional<Boolean> userInfoRequired
```
    If this property is set to 'true' then an OIDC UserInfo endpoint will be called.
  - sessionAgeExtension
```
@ConfigItem(defaultValue="5M")
public Duration sessionAgeExtension
```
    Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value then the expired ID token can be refreshed before the session has expired. This property will be ignored if the `token.refresh-expired` property has not been enabled.
  - javaScriptAutoRedirect
```
@ConfigItem(defaultValue="true")
public boolean javaScriptAutoRedirect
```
    If this property is set to 'true' then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single Page Applications since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS. If this property is set to `false` then a status code of '499' will be returned to allow the client to handle the redirect manually
  - idTokenRequired
```
@ConfigItem(defaultValueDocumentation="true")
public Optional<Boolean> idTokenRequired
```
    Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken will be generated in such cases.
  - internalIdTokenLifespan
```
@ConfigItem(defaultValueDocumentation="5M")
public Optional<Duration> internalIdTokenLifespan
```
    Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.
  - pkceRequired
```
@ConfigItem(defaultValueDocumentation="false")
public Optional<Boolean> pkceRequired
```
    Requires that a Proof Key for Code Exchange (PKCE) is used.
  - pkceSecret
```
@ConfigItem
public Optional<String> pkceSecret
```
    Secret which will be used to encrypt a Proof Key for Code Exchange (PKCE) code verifier in the code flow state. This secret must be set if PKCE is required but no client secret is set. The length of the secret which will be used to encrypt the code verifier must be 32 characters long.
- Constructor Detail
  - Authentication
```
public Authentication()
```
- Method Detail
  - getInternalIdTokenLifespan
```
public Optional<Duration> getInternalIdTokenLifespan()
```
  - setInternalIdTokenLifespan
```
public void setInternalIdTokenLifespan(Duration internalIdTokenLifespan)
```
  - isPkceRequired
```
public Optional<Boolean> isPkceRequired()
```
  - setPkceRequired
```
public void setPkceRequired(boolean pkceRequired)
```
  - getPkceSecret
```
public Optional<String> getPkceSecret()
```
  - setPkceSecret
```
public void setPkceSecret(String pkceSecret)
```
  - getErrorPath
```
public Optional<String> getErrorPath()
```
  - setErrorPath
```
public void setErrorPath(String errorPath)
```
  - isJavaScriptAutoRedirect
```
public boolean isJavaScriptAutoRedirect()
```
  - setJavaScriptAutoredirect
```
public void setJavaScriptAutoredirect(boolean autoRedirect)
```
  - getRedirectPath
```
public Optional<String> getRedirectPath()
```
  - setRedirectPath
```
public void setRedirectPath(String redirectPath)
```
  - getScopes
```
public Optional<List<String>> getScopes()
```
  - setScopes
```
public void setScopes(List<String> scopes)
```
  - getExtraParams
```
public Map<String,String> getExtraParams()
```
  - setExtraParams
```
public void setExtraParams(Map<String,String> extraParams)
```
  - setAddOpenidScope
```
public void setAddOpenidScope(boolean addOpenidScope)
```
  - isAddOpenidScope
```
public Optional<Boolean> isAddOpenidScope()
```
  - isForceRedirectHttpsScheme
```
public Optional<Boolean> isForceRedirectHttpsScheme()
```
  - setForceRedirectHttpsScheme
```
public void setForceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)
```
  - isRestorePathAfterRedirect
```
public boolean isRestorePathAfterRedirect()
```
  - setRestorePathAfterRedirect
```
public void setRestorePathAfterRedirect(boolean restorePathAfterRedirect)
```
  - isCookieForceSecure
```
public boolean isCookieForceSecure()
```
  - setCookieForceSecure
```
public void setCookieForceSecure(boolean cookieForceSecure)
```
  - getCookiePath
```
public String getCookiePath()
```
  - setCookiePath
```
public void setCookiePath(String cookiePath)
```
  - getCookieDomain
```
public Optional<String> getCookieDomain()
```
  - setCookieDomain
```
public void setCookieDomain(String cookieDomain)
```
  - isUserInfoRequired
```
public Optional<Boolean> isUserInfoRequired()
```
  - setUserInfoRequired
```
public void setUserInfoRequired(boolean userInfoRequired)
```
  - isRemoveRedirectParameters
```
public boolean isRemoveRedirectParameters()
```
  - setRemoveRedirectParameters
```
public void setRemoveRedirectParameters(boolean removeRedirectParameters)
```
  - isVerifyAccessToken
```
public boolean isVerifyAccessToken()
```
  - setVerifyAccessToken
```
public void setVerifyAccessToken(boolean verifyAccessToken)
```
  - getSessionAgeExtension
```
public Duration getSessionAgeExtension()
```
  - setSessionAgeExtension
```
public void setSessionAgeExtension(Duration sessionAgeExtension)
```
  - getCookiePathHeader
```
public Optional<String> getCookiePathHeader()
```
  - setCookiePathHeader
```
public void setCookiePathHeader(String cookiePathHeader)
```
  - isIdTokenRequired
```
public Optional<Boolean> isIdTokenRequired()
```
  - setIdTokenRequired
```
public void setIdTokenRequired(boolean idTokenRequired)
```
  - getCookieSuffix
```
public Optional<String> getCookieSuffix()
```
  - setCookieSuffix
```
public void setCookieSuffix(String cookieSuffix)
```
  - getResponseMode
```
public Optional<OidcTenantConfig.Authentication.ResponseMode> getResponseMode()
```
  - setResponseMode
```
public void setResponseMode(OidcTenantConfig.Authentication.ResponseMode responseMode)
```
  - getForwardParams
```
public Optional<List<String>> getForwardParams()
```
  - setForwardParams
```
public void setForwardParams(List<String> forwardParams)
```
  - getCookieSameSite
```
public OidcTenantConfig.Authentication.CookieSameSite getCookieSameSite()
```
  - setCookieSameSite
```
public void setCookieSameSite(OidcTenantConfig.Authentication.CookieSameSite cookieSameSite)
```
  - isAllowMultipleCodeFlows
```
public boolean isAllowMultipleCodeFlows()
```
  - setAllowMultipleCodeFlows
```
public void setAllowMultipleCodeFlows(boolean allowMultipleCodeFlows)
```

Class OidcTenantConfig.Authentication

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

responseMode

redirectPath

restorePathAfterRedirect

removeRedirectParameters

errorPath

verifyAccessToken

forceRedirectHttpsScheme

scopes

addOpenidScope

extraParams

forwardParams

cookieForceSecure

cookieSuffix

cookiePath

cookiePathHeader

cookieDomain

cookieSameSite

allowMultipleCodeFlows

userInfoRequired

sessionAgeExtension

javaScriptAutoRedirect

idTokenRequired

internalIdTokenLifespan

pkceRequired

pkceSecret

Constructor Detail

Authentication

Method Detail

getInternalIdTokenLifespan

setInternalIdTokenLifespan

isPkceRequired

setPkceRequired

getPkceSecret

setPkceSecret

getErrorPath

setErrorPath

isJavaScriptAutoRedirect

setJavaScriptAutoredirect

getRedirectPath

setRedirectPath

getScopes

setScopes

getExtraParams

setExtraParams

setAddOpenidScope

isAddOpenidScope

isForceRedirectHttpsScheme

setForceRedirectHttpsScheme

isRestorePathAfterRedirect

setRestorePathAfterRedirect

isCookieForceSecure

setCookieForceSecure

getCookiePath

setCookiePath

getCookieDomain

setCookieDomain

isUserInfoRequired

setUserInfoRequired

isRemoveRedirectParameters

setRemoveRedirectParameters

isVerifyAccessToken

setVerifyAccessToken

getSessionAgeExtension

setSessionAgeExtension

getCookiePathHeader

setCookiePathHeader

isIdTokenRequired

setIdTokenRequired

getCookieSuffix

setCookieSuffix

getResponseMode

setResponseMode

getForwardParams