com.elasticpath.xpf.connectivity.extensionpoint

Interface OpenIdClaimsExtractor

All Superinterfaces:

org.pf4j.ExtensionPoint

public interface OpenIdClaimsExtractor
extends org.pf4j.ExtensionPoint

Extracts claims from a UserInfo request made to the OpenID provider for use elsewhere in the system.

Method Summary

Modifier and Type	Method and Description
XPFOpenIdClaimsExtractionResult	extractClaims(XPFOpenIdClaimsExtractionContext context) Given a set of claims returned for a user, return a set of claims to be saved to their profile attributes.
Set<String>	getCustomScopes() Returns a list of custom scopes required to return custom claims.

Method Detail

getCustomScopes

Set<String> getCustomScopes()

Returns a list of custom scopes required to return custom claims.

Returns:

List The list of custom claims.

extractClaims

XPFOpenIdClaimsExtractionResult extractClaims(XPFOpenIdClaimsExtractionContext context)

Given a set of claims returned for a user, return a set of claims to be saved to their profile attributes. Recieves key-value pairs with the keys from the id_token. Returns key-value pairs of customer profile attributes with relevant CP_* keys.

Parameters:

context - The OpenId claims extraction context.

Returns:

XPFOpenIdClaimsExtractionResult Result of extracting claims.