Package net.shibboleth.oidc.profile.config

Interface OIDCUserInfoConfiguration

All Superinterfaces:

AttributeResolvingProfileConfiguration, AuthenticationProfileConfiguration, Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ClientAuthenticableProfileConfiguration, OAuth2DPoPProofValidatingProfileConfiguration, OAuth2ProfileConfiguration, OAuth2TokenEncryptionProfileConfiguration, OAuth2TokenValidatingProfileConfiguration, OIDCProfileConfiguration, OverriddenIssuerProfileConfiguration, ProfileConfiguration

All Known Implementing Classes:

DefaultOIDCUserInfoConfiguration

public interface OIDCUserInfoConfiguration
extends AttributeResolvingProfileConfiguration, OAuth2TokenEncryptionProfileConfiguration, OAuth2TokenValidatingProfileConfiguration

Configuration for an OpenID Connect core protocol UserInfo endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROFILE_ID	ID for this profile configuration.
static final String	PROTOCOL_URI	OIDC base protocol URI.

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

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
Set<String>	getDeniedUserInfoAttributes(ProfileRequestContext profileRequestContext)	Get the set of attribute IDs which should be omitted from the UserInfo token.

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

isResolveAttributes

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.oidc.profile.oauth2.config.OAuth2ClientAuthenticableProfileConfiguration

getClaimsValidator, getTokenEndpointAuthMethods, getUnregisteredClientPolicy

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2DPoPProofValidatingProfileConfiguration

getDpopProofClaimsValidator, getDpopProofNonceGenerator, getDpopProofSignatureValidationConfiguration, isRequireDpopProof

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenEncryptionProfileConfiguration

isEncryptionOptional

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenValidatingProfileConfiguration

getIssuedClaimsValidator

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

getIssuer

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

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Field Details

PROTOCOL_URI

@Nonnull
@NotEmpty
static final String PROTOCOL_URI

OIDC base protocol URI.

See Also:

• Constant Field Values

PROFILE_ID

@Nonnull
@NotEmpty
static final String PROFILE_ID

ID for this profile configuration.

See Also:

• Constant Field Values

Method Details

getDeniedUserInfoAttributes

@ConfigurationSetting(name="deniedUserInfoAttributes")
@Nonnull
@NonnullElements
@NotLive
Set<String> getDeniedUserInfoAttributes(@Nullable
 ProfileRequestContext profileRequestContext)

Get the set of attribute IDs which should be omitted from the UserInfo token.

Default behavior is to include all claims, but omiited claims also affect the set that may need to be embedded for recovery into the access/refresh tokens.

Parameters:

profileRequestContext - profile request context

Returns:

the attribute IDs to omit from UserInfo token