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

Class OID4VCTargetRoleMapper

java.lang.Object

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

org.keycloak.protocol.oid4vc.issuance.mappers.OID4VCTargetRoleMapper

All Implemented Interfaces:

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

public class OID4VCTargetRoleMapper
extends OID4VCMapper

Adds the users roles to the credential subject

Author:

Stefan Wiedemann

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_CONFIG_KEY
static final String	DEFAULT_CLAIM_NAME
static final String	MAPPER_ID

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

CLAIM_NAME, format, mapperModel, USER_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor	Description
OID4VCTargetRoleMapper()
OID4VCTargetRoleMapper(KeycloakSession keycloakSession)

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String name)
ProtocolMapper	create(KeycloakSession session)
String	getDisplayType()
String	getHelpText()
String	getId()
protected List<ProviderConfigProperty>	getIndividualConfigProperties()
List<String>	getMetadataAttributePath()	must return ordered list of attribute-names as they are added into the credential.
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.
void	validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)	Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

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

close, getAttributePrefix, getConfigProperties, getDisplayCategory, getProtocol, includeInMetadata, init, 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

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

DEFAULT_CLAIM_NAME

public static final String DEFAULT_CLAIM_NAME

See Also:

• Constant Field Values

CLIENT_CONFIG_KEY

public static final String CLIENT_CONFIG_KEY

See Also:

• Constant Field Values

MAPPER_ID

public static final String MAPPER_ID

See Also:

• Constant Field Values

Constructor Details

OID4VCTargetRoleMapper

public OID4VCTargetRoleMapper()

OID4VCTargetRoleMapper

public OID4VCTargetRoleMapper(KeycloakSession keycloakSession)

Method Details

getIndividualConfigProperties

protected List<ProviderConfigProperty> getIndividualConfigProperties()

Specified by:

getIndividualConfigProperties in class OID4VCMapper

getMetadataAttributePath

public List<String> getMetadataAttributePath()

Description copied from class: OID4VCMapper

must return ordered list of attribute-names as they are added into the credential. This is required for the metadata endpoint to add the appropriate path-attributes into the claim's description.

Overrides:

getMetadataAttributePath in class OID4VCMapper

Returns:

the attribute path that is being mapped into the credential

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

create

public static ProtocolMapperModel create(String name)

create

public ProtocolMapper create(KeycloakSession session)

validateConfig

public void validateConfig(KeycloakSession session,
 RealmModel realm,
 ProtocolMapperContainerModel client,
 ProtocolMapperModel mapperModel)
                    throws ProtocolMapperConfigException

Description copied from interface: ProtocolMapper

Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

client - client or clientTemplate

Throws:

ProtocolMapperConfigException - if configuration provided in mapperModel is not valid

getId

public String getId()

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