Package org.keycloak.broker.saml.mappers

Class UserAttributeMapper

java.lang.Object

org.keycloak.broker.provider.AbstractIdentityProviderMapper

org.keycloak.broker.saml.mappers.UserAttributeMapper

All Implemented Interfaces:

IdentityProviderMapper, SamlMetadataDescriptorUpdater, ConfiguredProvider, Provider, ProviderFactory<IdentityProviderMapper>

public class UserAttributeMapper
extends AbstractIdentityProviderMapper
implements SamlMetadataDescriptorUpdater

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTRIBUTE_FRIENDLY_NAME
static String	ATTRIBUTE_NAME
static String	ATTRIBUTE_NAME_FORMAT
static String[]	COMPATIBLE_PROVIDERS
static List<String>	NAME_FORMATS
static String	PROVIDER_ID
static String	USER_ATTRIBUTE

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

ANY_PROVIDER, DEFAULT_IDENTITY_PROVIDER_MAPPER_SYNC_MODES

Constructor Summary

Constructors

Constructor	Description
UserAttributeMapper()

Method Summary

Modifier and Type	Method	Description
String[]	getCompatibleProviders()
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.
boolean	supportsSyncMode(IdentityProviderSyncMode syncMode)
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.
void	updateMetadata(IdentityProviderMapperModel mapperModel, EntityDescriptorType entityDescriptor)

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

close, create, 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 Detail

COMPATIBLE_PROVIDERS

public static final String[] COMPATIBLE_PROVIDERS

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_FRIENDLY_NAME

public static final String ATTRIBUTE_FRIENDLY_NAME

See Also:

Constant Field Values

ATTRIBUTE_NAME_FORMAT

public static final String ATTRIBUTE_NAME_FORMAT

See Also:

Constant Field Values

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

See Also:

Constant Field Values

NAME_FORMATS

public static final List<String> NAME_FORMATS

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

Constant Field Values

Constructor Detail

UserAttributeMapper

public UserAttributeMapper()

Method Detail

supportsSyncMode

public boolean supportsSyncMode(IdentityProviderSyncMode syncMode)

Specified by:

supportsSyncMode in interface IdentityProviderMapper

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory<IdentityProviderMapper>

getCompatibleProviders

public String[] getCompatibleProviders()

Specified by:

getCompatibleProviders in interface IdentityProviderMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface IdentityProviderMapper

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface IdentityProviderMapper

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

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

updateMetadata

public void updateMetadata(IdentityProviderMapperModel mapperModel,
                           EntityDescriptorType entityDescriptor)

Specified by:

updateMetadata in interface SamlMetadataDescriptorUpdater