io.quarkus.oidc

Class OidcTenantConfig.Authentication

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.

Field Summary

Fields

Modifier and Type	Field and Description
Optional<String>	cookiePath Cookie path parameter value which, if set, will be used for the session and state cookies.
Map<String,String>	extraParams Additional properties which will be added as the query parameters to the authentication redirect URI.
boolean	forceRedirectHttpsScheme Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy.
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.
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

Constructor Summary

Constructors

Constructor and Description
Authentication()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getCookiePath()
Map<String,String>	getExtraParams()
Optional<String>	getRedirectPath()
Optional<List<String>>	getScopes()
boolean	isForceRedirectHttpsScheme()
boolean	isRestorePathAfterRedirect()
void	setCookiePath(String cookiePath)
void	setExtraParams(Map<String,String> extraParams)
void	setForceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)
void	setRedirectPath(String redirectPath)
void	setRestorePathAfterRedirect(boolean restorePathAfterRedirect)
void	setScopes(Optional<List<String>> scopes)

Methods inherited from class java.lang.Object

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

Field Detail

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.

restorePathAfterRedirect

@ConfigItem(defaultValue="true")
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.

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.

forceRedirectHttpsScheme

@ConfigItem(defaultValue="false")
public 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

extraParams

@ConfigItem
public Map<String,String> extraParams

Additional properties which will be added as the query parameters to the authentication redirect URI.

cookiePath

@ConfigItem
public Optional<String> cookiePath

Cookie path parameter value which, if set, will be used for the session and state cookies. It may need to be set when the redirect path has a root different to that of the original request URL.

Constructor Detail

Authentication

public Authentication()

Method Detail

getRedirectPath

public Optional<String> getRedirectPath()

setRedirectPath

public void setRedirectPath(String redirectPath)

getScopes

public Optional<List<String>> getScopes()

setScopes

public void setScopes(Optional<List<String>> scopes)

getExtraParams

public Map<String,String> getExtraParams()

setExtraParams

public void setExtraParams(Map<String,String> extraParams)

isForceRedirectHttpsScheme

public boolean isForceRedirectHttpsScheme()

setForceRedirectHttpsScheme

public void setForceRedirectHttpsScheme(boolean forceRedirectHttpsScheme)

isRestorePathAfterRedirect

public boolean isRestorePathAfterRedirect()

setRestorePathAfterRedirect

public void setRestorePathAfterRedirect(boolean restorePathAfterRedirect)

getCookiePath

public Optional<String> getCookiePath()

setCookiePath

public void setCookiePath(String cookiePath)