Interface OpenIdConfiguration

All Known Implementing Classes:
OauthConfigurationProperties.OpenIdConfigurationProperties
public interface OpenIdConfiguration
Configuration for OpenID not specific to a client.
Since:
1.2.0
Author:
James Kleeh

  • Method Details

    • getLogoutUri

      String getLogoutUri()
      Returns:
      the Callback Uri

    • getEndSession

      Optional<EndSessionConfiguration> getEndSession()
      Returns:
      Optional end session configuration

    • getClaimsValidation

      OpenIdClaimsValidationConfiguration getClaimsValidation()
      Returns:
      Claims validation configuration

    • getAdditionalClaims

      OpenIdAdditionalClaimsConfiguration getAdditionalClaims()
      Returns:
      Claims configuration

    • getQualifyUsernameWithProvider

      default @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. 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.
      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
      Since:
      5.5.2