Package org.keycloak.protocol.oid4vc.issuance.mappers

Class OID4VCUserAttributeMapper

java.lang.Object

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCUserAttributeMapper

All Implemented Interfaces:

OID4VCEnvironmentProviderFactory, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class OID4VCUserAttributeMapper
extends OID4VCMapper

Allows to add user attributes to the credential subject

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGGREGATE_ATTRIBUTES_KEY
static final String	MAPPER_ID
static final String	SUBJECT_PROPERTY_CONFIG_KEY
static final String	USER_ATTRIBUTE_KEY

Fields inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

mapperModel, SUPPORTED_CREDENTIALS_KEY

Constructor Summary

Constructors

Constructor	Description
OID4VCUserAttributeMapper()

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String mapperName, String userAttribute, String propertyName, boolean aggregateAttributes)
ProtocolMapper	create(KeycloakSession session)
String	getDisplayType()
String	getHelpText()
String	getId()
protected List<ProviderConfigProperty>	getIndividualConfigProperties()
void	setClaimsForCredential(VerifiableCredential verifiableCredential, UserSessionModel userSessionModel)	Set the claims to credential, like f.e.
void	setClaimsForSubject(Map<String,Object> claims, UserSessionModel userSessionModel)	Set the claims to the credential subject.

Methods inherited from class org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCMapper

close, getConfigProperties, getDisplayCategory, getProtocol, init, isTypeSupported, postInit, setMapperModel

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

Methods inherited from interface org.keycloak.protocol.oid4vc.OID4VCEnvironmentProviderFactory

isSupported

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Details

MAPPER_ID

public static final String MAPPER_ID

See Also:

• Constant Field Values

SUBJECT_PROPERTY_CONFIG_KEY

public static final String SUBJECT_PROPERTY_CONFIG_KEY

See Also:

• Constant Field Values

USER_ATTRIBUTE_KEY

public static final String USER_ATTRIBUTE_KEY

See Also:

• Constant Field Values

AGGREGATE_ATTRIBUTES_KEY

public static final String AGGREGATE_ATTRIBUTES_KEY

See Also:

• Constant Field Values

Constructor Details

OID4VCUserAttributeMapper

public OID4VCUserAttributeMapper()

Method Details

getIndividualConfigProperties

protected List<ProviderConfigProperty> getIndividualConfigProperties()

Specified by:

getIndividualConfigProperties in class OID4VCMapper

setClaimsForCredential

public void setClaimsForCredential(VerifiableCredential verifiableCredential,
 UserSessionModel userSessionModel)

Description copied from class: OID4VCMapper

Set the claims to credential, like f.e. the context

Specified by:

setClaimsForCredential in class OID4VCMapper

setClaimsForSubject

public void setClaimsForSubject(Map<String,Object> claims,
 UserSessionModel userSessionModel)

Description copied from class: OID4VCMapper

Set the claims to the credential subject.

Specified by:

setClaimsForSubject in class OID4VCMapper

create

public static ProtocolMapperModel create(String mapperName,
 String userAttribute,
 String propertyName,
 boolean aggregateAttributes)

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

create

public ProtocolMapper create(KeycloakSession session)

getId

public String getId()