Package net.shibboleth.oidc.profile.config

Interface OIDCAuthenticationRelyingPartyProfileConfiguration

All Superinterfaces:
AuthenticationProfileConfiguration, Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2AuthorizationProfileConfiguration, OAuth2ClientAuthenticableClientProfileConfiguration, OAuth2FlowAwareProfileConfiguration, OAuth2ProfileConfiguration, OAuth2TokenEncryptionProfileConfiguration, OIDCAuthenticationProfileConfiguration, OIDCFlowAwareProfileConfiguration, OIDCProfileConfiguration, OIDCSSOProfileConfiguration, OIDCSSORelyingPartyConfiguration, OverriddenIssuerProfileConfiguration, ProfileConfiguration
All Known Subinterfaces:
OAuth2PushedAuthorizationRequestConfiguration
All Known Implementing Classes:
DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOIDCAuthorizationConfiguration
public interface OIDCAuthenticationRelyingPartyProfileConfiguration extends OIDCAuthenticationProfileConfiguration, OIDCSSORelyingPartyConfiguration
Configuration of an OIDC 1.0 authentication request.

This is specific to the role of the RelyingParty (RP).

  • Method Details

    • getUserInfoHttpRequestMethod

      @ConfigurationSetting(name="userInfoHttpRequestMethod") @Nullable OAuth2AuthorizationProfileConfiguration.HttpRequestMethod getUserInfoHttpRequestMethod(@Nullable ProfileRequestContext profileRequestContext)
      Get the HTTP request method for the UserInfo request. Both GET and POST are supported.
      Parameters:
      profileRequestContext - current profile request context
      Returns:
      the UserInfo HTTP request method
      Since:
      2.2.0

    • isRetrieveUserInfoEndpointClaims

      @ConfigurationSetting(name="retrieveUserInfoEndpointClaims") boolean isRetrieveUserInfoEndpointClaims(@Nonnull ProfileRequestContext profileRequestContext)
      Get whether to make a request to the UserInfo Endpoint to obtain authenticated End-User claims.
      Parameters:
      profileRequestContext - current profile request context
      Returns:
      whether to make a request to the UserInfo Endpoint
      Since:
      2.2.0

    • isSignRequestObject

      @ConfigurationSetting(name="signRequestObject") boolean isSignRequestObject(@Nullable ProfileRequestContext profileRequestContext)
      Should the RequestObject (if configured) be signed?
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      true iff the RequestObject should be signed, false otherwise.
      Since:
      2.2.0

    • isEncryptRequestObject

      @ConfigurationSetting(name="encryptRequestObject") boolean isEncryptRequestObject(@Nullable ProfileRequestContext profileRequestContext)
      Should the RequestObject (if configured) be encrypted?
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      true iff the RequestObject should be encrypted, false otherwise.
      Since:
      2.2.0

    • isProxiedAuthnInstant

      @ConfigurationSetting(name="proxiedAuthnInstant") boolean isProxiedAuthnInstant(@Nullable ProfileRequestContext profileRequestContext)
      Gets whether authentication results produced by use of this profile should carry the proxied assertion's auth_time from the id_token, rather than the current time.

      Defaults to true.

      Parameters:
      profileRequestContext - current profile request context
      Returns:
      whether to proxy across the inbound auth_time
      Since:
      2.2.0

    • getRedirectUriOverride

      @ConfigurationSetting(name="redirectUriOverride") @Nullable @NotEmpty String getRedirectUriOverride(@Nullable ProfileRequestContext profileRequestContext)
      Get the redirect_uri override if set.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      the redirect_uri override
      Since:
      2.2.0

    • isTlsServerValidationSufficient

      @ConfigurationSetting(name="tlsServerValidationSufficient") boolean isTlsServerValidationSufficient(@Nullable ProfileRequestContext profileRequestContext)
      Is TLS server validation of the token endpoint sufficient to verify an id_token without checking the id_token signature.
      Parameters:
      profileRequestContext - profile request context
      Returns:
      true if TLS server validation is required to verify the id_token. False if the token signature should be validated.
      Since:
      2.2.0