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

Interface OAuth2ClientAuthenticableClientProfileConfiguration

All Superinterfaces:

net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration, Component, net.shibboleth.idp.profile.config.ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, net.shibboleth.idp.profile.config.ProfileConfiguration

All Known Subinterfaces:

OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCSSORelyingPartyConfiguration

public interface OAuth2ClientAuthenticableClientProfileConfiguration
extends net.shibboleth.idp.authn.config.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 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.idp.profile.config.ConditionalProfileConfiguration

getActivationCondition

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

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

getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration

Method Detail

getTokenEndpointAuthMethod

@Nonnull
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

@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

@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