Class OauthConfigurationProperties.OpenIdConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthConfigurationProperties.OpenIdConfigurationProperties

All Implemented Interfaces:

OpenIdConfiguration

Enclosing class:

OauthConfigurationProperties

@ConfigurationProperties("openid")
public static class OauthConfigurationProperties.OpenIdConfigurationProperties
extends Object
implements OpenIdConfiguration

OpenID configuration.

Since:

1.2.0

Author:

Sergio del Amo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OauthConfigurationProperties.OpenIdConfigurationProperties.AdditionalClaimsConfigurationProperties	Claims configuration.
static class	OauthConfigurationProperties.OpenIdConfigurationProperties.ClaimsValidationConfigurationProperties	Claims Validator configuration.
static class	OauthConfigurationProperties.OpenIdConfigurationProperties.EndSessionConfigurationProperties	End session configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
OpenIdConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
OauthConfigurationProperties.OpenIdConfigurationProperties.AdditionalClaimsConfigurationProperties	getAdditionalClaims()
OauthConfigurationProperties.OpenIdConfigurationProperties.ClaimsValidationConfigurationProperties	getClaimsValidation()
Optional<EndSessionConfiguration>	getEndSession()
String	getLogoutUri()
@NonNull Optional<Boolean>	getQualifyUsernameWithProvider()	Whether the username of an Authentication built from an OpenID provider response, by the default OpenIdAuthenticationMapper at login or by the UserInfo endpoint token validator, is qualified with the provider name, as providerName:subject, instead of being the bare sub claim.
void	setAdditionalClaims(OauthConfigurationProperties.OpenIdConfigurationProperties.AdditionalClaimsConfigurationProperties claims)
void	setClaimsValidation(OauthConfigurationProperties.OpenIdConfigurationProperties.ClaimsValidationConfigurationProperties claimsValidator)
void	setEndSession(OauthConfigurationProperties.OpenIdConfigurationProperties.EndSessionConfigurationProperties endSession)	The end session configuration.
void	setLogoutUri(String logoutUri)	The URI used to log out of an OpenID provider.
void	setQualifyUsernameWithProvider(@Nullable Boolean qualifyUsernameWithProvider)	Whether the username of an authentication built from an OpenID provider response, by the default OpenID authentication mapper at login or by the `UserInfo` endpoint token validator, is the `sub` claim qualified with the provider name (`providerName:subject`) instead of the bare `sub` claim.

Methods inherited from class Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

Constructor Details

OpenIdConfigurationProperties

public OpenIdConfigurationProperties()

Method Details

getLogoutUri

public String getLogoutUri()

Specified by:

getLogoutUri in interface OpenIdConfiguration

Returns:

the Callback Uri

setLogoutUri

public void setLogoutUri(String logoutUri)

The URI used to log out of an OpenID provider. Default value ("/oauth/logout").

Parameters:

logoutUri - The logout uri

getEndSession

public Optional<EndSessionConfiguration> getEndSession()

Specified by:

getEndSession in interface OpenIdConfiguration

Returns:

Optional end session configuration

setEndSession

public void setEndSession(OauthConfigurationProperties.OpenIdConfigurationProperties.EndSessionConfigurationProperties endSession)

The end session configuration.

Parameters:

endSession - The end session configuration

getClaimsValidation

public OauthConfigurationProperties.OpenIdConfigurationProperties.ClaimsValidationConfigurationProperties getClaimsValidation()

Specified by:

getClaimsValidation in interface OpenIdConfiguration

Returns:

Claims Validator Configuration

setClaimsValidation

public void setClaimsValidation(OauthConfigurationProperties.OpenIdConfigurationProperties.ClaimsValidationConfigurationProperties claimsValidator)

Parameters:

claimsValidator - Claims Validator Configuration

getAdditionalClaims

public OauthConfigurationProperties.OpenIdConfigurationProperties.AdditionalClaimsConfigurationProperties getAdditionalClaims()

Specified by:

getAdditionalClaims in interface OpenIdConfiguration

Returns:

Claims configuration

setAdditionalClaims

public void setAdditionalClaims(OauthConfigurationProperties.OpenIdConfigurationProperties.AdditionalClaimsConfigurationProperties claims)

Parameters:

claims - The Claims Configuration

getQualifyUsernameWithProvider

public @NonNull Optional<Boolean> getQualifyUsernameWithProvider()

Description copied from interface: OpenIdConfiguration

Whether the username of an Authentication built from an OpenID provider response, by the default OpenIdAuthenticationMapper at login or by the UserInfo endpoint token validator, is qualified with the provider name, as providerName:subject, instead of being the bare sub claim. The sub claim is only unique within one provider, so an unqualified username lets a user at one provider share identity with a user at another provider which issued the same sub.

Specified by:

getQualifyUsernameWithProvider in interface OpenIdConfiguration

Returns:

true to always qualify the username, false to never qualify it, or empty to qualify only when more than one enabled OAuth 2.0 client, other than client-credentials-only clients, is configured under micronaut.security.oauth2.clients

setQualifyUsernameWithProvider

public void setQualifyUsernameWithProvider(@Nullable Boolean qualifyUsernameWithProvider)

Whether the username of an authentication built from an OpenID provider response, by the default OpenID authentication mapper at login or by the `UserInfo` endpoint token validator, is the `sub` claim qualified with the provider name (`providerName:subject`) instead of the bare `sub` claim. The `sub` claim is only unique within one provider. If not set, the username is qualified only when more than one enabled OAuth 2.0 client, other than client-credentials-only clients, is configured under `micronaut.security.oauth2.clients`. It does not apply when `micronaut.security.authentication` is `idtoken`.

Parameters:

qualifyUsernameWithProvider - Whether to qualify the username with the provider name.

Since:

5.5.2