Package org.keycloak.broker.oid4vp.mappers

Class OID4VPSdJwtUserSessionAttributeMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.oid4vp.mappers.AbstractOID4VPClaimMapper

org.keycloak.broker.oid4vp.mappers.OID4VPSdJwtUserSessionAttributeMapper

All Implemented Interfaces:

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

public class OID4VPSdJwtUserSessionAttributeMapper
extends AbstractOID4VPClaimMapper

Imports a claim of the presented SD JWT credential into a user session attribute, so it can be surfaced in tokens through the user session note protocol mappers. Session notes hold one string value: multivalued selections are joined with a comma and object values are stored as their JSON representation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE
static final String	PROVIDER_ID

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
OID4VPSdJwtUserSessionAttributeMapper()

Method Summary

Modifier and Type	Method	Description
protected void	applySessionNote(IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
void	importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)	Called after UserModel is created for first time for this user.
void	preprocessFederatedIdentity(KeycloakSession session, RealmModel realm, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context)	The note is per login state, so it is also set during preprocessing, which runs for every login.
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, 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

ATTRIBUTE

public static final String ATTRIBUTE

See Also:

• Constant Field Values

Constructor Details

OID4VPSdJwtUserSessionAttributeMapper

public OID4VPSdJwtUserSessionAttributeMapper()

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)

The note is per login state, so it is also set during preprocessing, which runs for every login. The user centric hooks below never run for an existing user whose effective sync mode is IMPORT.

Specified by:

preprocessFederatedIdentity in interface IdentityProviderMapper

Overrides:

preprocessFederatedIdentity in class AbstractIdentityProviderMapper

importNewUser

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

Description copied from interface: IdentityProviderMapper

Called after UserModel is created for first time for this user. Called after "FirstBrokerLogin" flow

Specified by:

importNewUser in interface IdentityProviderMapper

Overrides:

importNewUser 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

applySessionNote

protected void applySessionNote(IdentityProviderMapperModel mapperModel,
 BrokeredIdentityContext context)