Interface OIDCAuthenticationProfileConfiguration

All Superinterfaces:
OAuth2AuthorizationProfileConfiguration
All Known Subinterfaces:
OAuth2PushedAuthorizationRequestConfiguration, OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCAuthorizationConfiguration
All Known Implementing Classes:
DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOIDCAuthorizationConfiguration

public interface OIDCAuthenticationProfileConfiguration extends OAuth2AuthorizationProfileConfiguration
Generic configuration for an OIDC 1.0 authentication request.
  • Field Details

  • Method Details

    • isUseRequestObject

      @ConfigurationSetting(name="useRequestObject") boolean isUseRequestObject(@Nullable ProfileRequestContext profileRequestContext)
      Should OpenID specific authentication request parameters should be passed in a single, self contained, JWT?
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      whether authentication request parameters should be passed in a single, self contained, JWT
    • getAuthenticationMethodsReferencesTranslationStrategy

      @ConfigurationSetting(name="authenticationMethodsReferencesTranslationStrategy") @Nullable Function<Collection<String>,Collection<Principal>> getAuthenticationMethodsReferencesTranslationStrategy(@Nullable ProfileRequestContext prc)
      Get the function used to translate AMRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.
      Parameters:
      prc - current profile request context
      Returns:
      translation function
      Since:
      2.2.0
    • getAuthenticationContextClassReferenceTranslationStrategy

      @ConfigurationSetting(name="authenticationContextClassReferenceTranslationStrategy") @Nullable Function<Collection<String>,Collection<Principal>> getAuthenticationContextClassReferenceTranslationStrategy(@Nullable ProfileRequestContext prc)
      Get the function used to translate ACRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.
      Parameters:
      prc - current profile request context
      Returns:
      translation function
      Since:
      2.2.0
    • getLoginHint

      @ConfigurationSetting(name="loginHint") @Nullable @NotEmpty String getLoginHint(@Nullable ProfileRequestContext profileRequestContext)
      Get the login_hint to use.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the login_hint to use
      Since:
      2.2.0
    • getMaxAuthenticationAge

      @ConfigurationSetting(name="maxAuthenticationAge") @Nullable Duration getMaxAuthenticationAge(@Nullable ProfileRequestContext profileRequestContext)
      Get the max authentication age.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      max authentication age
      Since:
      2.2.0
    • getDisplay

      @ConfigurationSetting(name="display") @Nullable String getDisplay(@Nullable ProfileRequestContext profileRequestContext)
      Get the display parameter to use.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the display parameter value
      Since:
      3.1.0