Interface ClaimsProvider
- All Known Subinterfaces:
AttributeDataAccessProvider,AttributeRepository
public interface ClaimsProvider
A plugin-provided service that can obtain claim values for a particular user and OAuth client.
- Since:
- 4.1.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault AttributesgetClaimValues(Set<RequestedClaimAttribute> requestedClaimAttributes, Set<ScopeValue> scopeValues, AuthenticationAttributes userAuthenticationAttributes, @Nullable ConsentorResultAttributes consentorResultAttributes, OAuthClient client) Gets the claim values for the requested claims, user, consentor results, and OAuth client.getClaimValues(Set<RequestedClaimAttribute> requestedClaimAttributes, Set<ScopeValue> scopeValues, AuthenticationAttributes userAuthenticationAttributes, OAuthClient client) Get the claim values for the requested claims, user and OAuth client.
-
Method Details
-
getClaimValues
Attributes getClaimValues(Set<RequestedClaimAttribute> requestedClaimAttributes, Set<ScopeValue> scopeValues, AuthenticationAttributes userAuthenticationAttributes, OAuthClient client) Get the claim values for the requested claims, user and OAuth client. If no claims are available for the given inputs, returnAttributes.empty()}.- Parameters:
requestedClaimAttributes- the attributes to retrieve for a set of claimsscopeValues- the scopes related to the requested attributesuserAuthenticationAttributes- user authentication attributesclient- the OAuth client making the request- Returns:
- attributes representing the claims names and values
-
getClaimValues
default Attributes getClaimValues(Set<RequestedClaimAttribute> requestedClaimAttributes, Set<ScopeValue> scopeValues, AuthenticationAttributes userAuthenticationAttributes, @Nullable ConsentorResultAttributes consentorResultAttributes, OAuthClient client) Gets the claim values for the requested claims, user, consentor results, and OAuth client. If no claims are available for the given inputs, returnAttributes.empty().- Parameters:
requestedClaimAttributes- the attributes to retrieve for a set of claimsscopeValues- the scopes related to the requested attributesuserAuthenticationAttributes- user authentication attributesconsentorResultAttributes- attributes that were provided by a consentorclient- the OAuth client making the request- Returns:
- attributes representing the claims names and values
-