Package org.keycloak.broker.oid4vp.mappers

Class AbstractOID4VPClaimMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.oid4vp.mappers.AbstractOID4VPClaimMapper

All Implemented Interfaces:

IdentityProviderMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<IdentityProviderMapper>

Direct Known Subclasses:

OID4VPSdJwtUserAttributeMapper, OID4VPSdJwtUserSessionAttributeMapper

public abstract class AbstractOID4VPClaimMapper
extends AbstractIdentityProviderMapper
implements EnvironmentDependentProviderFactory

Base for OID4VP identity provider mappers that read a claim of the verified credential presentation, addressed by a ClaimPath over the claims JSON. Subclasses decide where the resolved values go. Not tied to a credential format: any format whose verification yields claims JSON under OID4VPIdentityProvider.CREDENTIAL_CLAIMS can build on it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLAIM
protected static final org.jboss.logging.Logger	logger

Fields inherited from interface org.keycloak.broker.provider.IdentityProviderMapper

ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES

Constructor Summary

Constructors

Constructor	Description
AbstractOID4VPClaimMapper()

Method Summary

Modifier and Type	Method	Description
protected static ProviderConfigProperty	claimProperty()
protected List<String>	claimValues(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
protected com.fasterxml.jackson.databind.JsonNode	credentialClaims(BrokeredIdentityContext context)
String[]	getCompatibleProviders()
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
boolean	supportsSyncMode(IdentityProviderSyncMode syncMode)
protected String	value(com.fasterxml.jackson.databind.JsonNode node)

Methods inherited from class org.keycloak.broker.provider.AbstractIdentityProviderMapper

close, create, dependsOn, importNewUser, init, postInit, preprocessFederatedIdentity, updateBrokeredUser, updateBrokeredUserLegacy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getConfigProperties, getHelpText

Methods inherited from interface org.keycloak.broker.provider.IdentityProviderMapper

getDisplayCategory, getDisplayType

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, getId, order

Field Details

logger

protected static final org.jboss.logging.Logger logger

CLAIM

public static final String CLAIM

See Also:

• Constant Field Values

Constructor Details

AbstractOID4VPClaimMapper

public AbstractOID4VPClaimMapper()

Method Details

claimProperty

protected static ProviderConfigProperty claimProperty()

getCompatibleProviders

public String[] getCompatibleProviders()

Specified by:

getCompatibleProviders in interface IdentityProviderMapper

supportsSyncMode

public boolean supportsSyncMode(IdentityProviderSyncMode syncMode)

Specified by:

supportsSyncMode in interface IdentityProviderMapper

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

credentialClaims

protected com.fasterxml.jackson.databind.JsonNode credentialClaims(BrokeredIdentityContext context)

claimValues

protected List<String> claimValues(IdentityProviderMapperModel mapperModel,
 BrokeredIdentityContext context)

value

protected String value(com.fasterxml.jackson.databind.JsonNode node)