Package net.shibboleth.oidc.profile.oauth2.config

Interface OAuth2ClientAuthenticableClientProfileConfiguration

All Superinterfaces:
AuthenticationProfileConfiguration, Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, ProfileConfiguration
All Known Subinterfaces:
OAuth2PushedAuthorizationRequestConfiguration, OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCSSORelyingPartyConfiguration, OIDCSSORelyingPartyConfigurationEx
All Known Implementing Classes:
AbstractOAuth2ClientAuthenticableProfileConfiguration, AbstractOAuth2FlowAwareProfileConfiguration, AbstractOAuth2TokenValidatingConfiguration, AbstractOIDCSSOConfiguration, DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOAuth2TokenConfiguration, DefaultOAuth2TokenIntrospectionConfiguration, DefaultOAuth2TokenRevocationConfiguration, DefaultOIDCAuthorizationConfiguration, DefaultOIDCDynamicRegistrationConfiguration, DefaultOIDCUserInfoConfiguration
public interface OAuth2ClientAuthenticableClientProfileConfiguration extends AuthenticationProfileConfiguration, OAuth2ProfileConfiguration
OAuth 2.0 profile configurations that support OAuth-defined client authentication methods.

This is specific to the role of the OAuth 2.0 client.

  • Method Details

    • getTokenEndpointAuthMethod

      @ConfigurationSetting(name="tokenEndpointAuthMethod") @Nullable String getTokenEndpointAuthMethod(@Nullable ProfileRequestContext profileRequestContext)
      Get the token endpoint authentication method to use with an OpenID Provider.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      the token endpoint authentication method to use.
      Since:
      2.2.0

    • getClientCredential

      @ConfigurationSetting(name="clientCredential") @Nullable ClientSecretCredential getClientCredential(@Nullable ProfileRequestContext profileRequestContext)
      Get the client credential for the given context. Typically a client_secret associated with the current client_id.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      the client credential
      Since:
      2.2.0

    • getClientId

      @ConfigurationSetting(name="clientId") @Nullable @NotEmpty String getClientId(@Nullable ProfileRequestContext profileRequestContext)
      Get the client_id appropriate for the given context. Typically that associated with the chosen OpenID Connect Provider.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      the client_id
      Since:
      2.2.0

    • isUseTargetedEndpointAsJWTAudience

      @ConfigurationSetting(name="useTargetedEndpointAsJWTAudience") boolean isUseTargetedEndpointAsJWTAudience(@Nullable ProfileRequestContext profileRequestContext)
      Should the audience claim of a JWT be targeted to a specific endpoint of the recipient? The targeted audience would be specific to the context in which the JWT is used. For example, the token endpoint URL in a JWT client assertion.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      true if the audience claim should use a targeted endpoint of the recipient, false if the audience value must be the issuer identifier of the recipient
      Since:
      3.3.0

    • getClientAuthenticationJWTType

      @ConfigurationSetting(name="clientAuthenticationJWTType") @Nullable @NotEmpty String getClientAuthenticationJWTType(@Nullable ProfileRequestContext profileRequestContext)
      Get the 'typ' header parameter value for a client authentication JWT.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      the 'typ' header parameter value for a client authentication JWT.
      Since:
      3.3.0

    • isRequireSingleJWTAudience

      @ConfigurationSetting(name="requireSingleJWTAudience") boolean isRequireSingleJWTAudience(@Nullable ProfileRequestContext profileRequestContext)
      Get whether single audience value is required in the JWT audience claim. Otherwise the claim can be a list of values.
      Parameters:
      profileRequestContext - the profile request context
      Returns:
      true if single audience value is required, false if multiple values are allowed
      Since:
      3.3.0