Package org.keycloak.broker.oid4vp.mappers

Class OID4VPSdJwtUserAttributeMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.oid4vp.mappers.AbstractOID4VPClaimMapper

org.keycloak.broker.oid4vp.mappers.OID4VPSdJwtUserAttributeMapper

All Implemented Interfaces:

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

public class OID4VPSdJwtUserAttributeMapper
extends AbstractOID4VPClaimMapper

Maps a claim of the presented SD JWT credential to a user property or attribute. A single mapper covers the credential value types: string, number and boolean claims become a single text value, arrays become a multivalued attribute, and object values are imported as their JSON representation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMAIL
static final String	FIRST_NAME
static final String	LAST_NAME
static final String	PROVIDER_ID
static final String	USER_ATTRIBUTE
static final String	USERNAME

Fields inherited from class org.keycloak.broker.oid4vp.mappers.AbstractOID4VPClaimMapper

CLAIM, logger

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

ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES

Constructor Summary

Constructors

Constructor	Description
OID4VPSdJwtUserAttributeMapper()

Method Summary

Modifier and Type	Method	Description
protected String	attribute(IdentityProviderMapperModel mapperModel)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
void	preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)	Called to determine what keycloak username and email to use to process the login request from the external IDP.
protected void	setIfPresent(List<String> values, Consumer<String> setter)
void	updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)	Called when this user has logged in before and has already been imported.

Methods inherited from class org.keycloak.broker.oid4vp.mappers.AbstractOID4VPClaimMapper

claimProperty, claimValues, credentialClaims, getCompatibleProviders, isSupported, supportsSyncMode, value

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

close, create, dependsOn, importNewUser, init, postInit, 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

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

See Also:

• Constant Field Values

FIRST_NAME

public static final String FIRST_NAME

See Also:

• Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

• Constant Field Values

Constructor Details

OID4VPSdJwtUserAttributeMapper

public OID4VPSdJwtUserAttributeMapper()

Method Details

getId

public String getId()

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

getDisplayCategory

public String getDisplayCategory()

getDisplayType

public String getDisplayType()

getHelpText

public String getHelpText()

preprocessFederatedIdentity

public void preprocessFederatedIdentity(KeycloakSession session,
 RealmModel realm,
 IdentityProviderMapperModel mapperModel,
 BrokeredIdentityContext context)

Description copied from interface: IdentityProviderMapper

Called to determine what keycloak username and email to use to process the login request from the external IDP. It's called before "FirstBrokerLogin" flow, so can be used to map attributes to BrokeredIdentityContext ( BrokeredIdentityContext.setUserAttribute ), which will be available on "Review Profile" page and in authenticators during FirstBrokerLogin flow

Specified by:

preprocessFederatedIdentity in interface IdentityProviderMapper

Overrides:

preprocessFederatedIdentity in class AbstractIdentityProviderMapper

updateBrokeredUser

public void updateBrokeredUser(KeycloakSession session,
 RealmModel realm,
 UserModel user,
 IdentityProviderMapperModel mapperModel,
 BrokeredIdentityContext context)

Description copied from interface: IdentityProviderMapper

Called when this user has logged in before and has already been imported.

Specified by:

updateBrokeredUser in interface IdentityProviderMapper

Overrides:

updateBrokeredUser in class AbstractIdentityProviderMapper

setIfPresent

protected void setIfPresent(List<String> values,
 Consumer<String> setter)

attribute

protected String attribute(IdentityProviderMapperModel mapperModel)