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

Interface OAuth2ClientAuthenticableClientProfileConfiguration

All Superinterfaces:

AuthenticationProfileConfiguration, Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, ProfileConfiguration

All Known Subinterfaces:

OAuth2PushedAuthorizationRequestConfiguration, OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCSSORelyingPartyConfiguration

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.

Field Summary

Fields inherited from interface net.shibboleth.profile.config.ProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
ClientSecretCredential	getClientCredential(ProfileRequestContext profileRequestContext)	Get the client credential for the given context.
String	getClientId(ProfileRequestContext profileRequestContext)	Get the client_id appropriate for the given context.
String	getTokenEndpointAuthMethod(ProfileRequestContext profileRequestContext)	Get the token endpoint authentication method to use with an OpenID Provider.

Methods inherited from interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

getAuthenticationFlows, getDefaultAuthenticationMethods, getPostAuthenticationFlows, getProxyCount, isForceAuthn, isLocal

Methods inherited from interface net.shibboleth.profile.config.ConditionalProfileConfiguration

getActivationCondition

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.profile.config.ProfileConfiguration

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

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