Uses of Class
org.keycloak.models.ProtocolMapperModel

Packages that use ProtocolMapperModel

Package	Description
org.keycloak.migration
org.keycloak.migration.migrators
org.keycloak.models
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.delegate
org.keycloak.models.jpa
org.keycloak.models.utils
org.keycloak.organization.protocol.mappers.oidc
org.keycloak.organization.protocol.mappers.saml
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.docker.mapper
org.keycloak.protocol.oid4vc
org.keycloak.protocol.oid4vc.issuance.mappers
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.mappers
org.keycloak.protocol.oidc.utils
org.keycloak.protocol.saml
org.keycloak.protocol.saml.mappers
org.keycloak.services.migration
org.keycloak.services.util
org.keycloak.storage
org.keycloak.storage.client
org.keycloak.storage.federated
org.keycloak.storage.jpa

Uses of ProtocolMapperModel in org.keycloak.migration

Methods in org.keycloak.migration that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	MigrationProvider.getBuiltinMappers(String protocol)

Uses of ProtocolMapperModel in org.keycloak.migration.migrators

Methods in org.keycloak.migration.migrators with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
protected void	MigrateTo1_6_0.migrateRealm(KeycloakSession session, ProtocolMapperModel localeMapper, RealmModel realm)

Uses of ProtocolMapperModel in org.keycloak.models

Methods in org.keycloak.models that return ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ProtocolMapperContainerModel.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ProtocolMapperContainerModel.getProtocolMapperById(String id)
ProtocolMapperModel	ProtocolMapperContainerModel.getProtocolMapperByName(String protocol, String name)

Methods in org.keycloak.models that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Stream<ProtocolMapperModel>	ClientSessionContext.getProtocolMappersStream()	Returns protocol mappers as a stream.
Stream<ProtocolMapperModel>	ProtocolMapperContainerModel.getProtocolMappersStream()	Returns protocol mappers as a stream.

Methods in org.keycloak.models with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ProtocolMapperContainerModel.addProtocolMapper(ProtocolMapperModel model)
void	UserProvider.preRemove(ProtocolMapperModel protocolMapper)	Called when a protocolMapper is removed
void	ProtocolMapperContainerModel.removeProtocolMapper(ProtocolMapperModel mapping)
void	ProtocolMapperContainerModel.updateProtocolMapper(ProtocolMapperModel mapping)

Uses of ProtocolMapperModel in org.keycloak.models.cache.infinispan

Methods in org.keycloak.models.cache.infinispan that return ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientAdapter.getProtocolMapperById(String id)
ProtocolMapperModel	ClientScopeAdapter.getProtocolMapperById(String id)
ProtocolMapperModel	ClientAdapter.getProtocolMapperByName(String protocol, String name)
ProtocolMapperModel	ClientScopeAdapter.getProtocolMapperByName(String protocol, String name)

Methods in org.keycloak.models.cache.infinispan that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Stream<ProtocolMapperModel>	ClientAdapter.getProtocolMappersStream()
Stream<ProtocolMapperModel>	ClientScopeAdapter.getProtocolMappersStream()

Methods in org.keycloak.models.cache.infinispan with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
void	UserCacheSession.preRemove(ProtocolMapperModel protocolMapper)
void	ClientAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	ClientScopeAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	ClientAdapter.updateProtocolMapper(ProtocolMapperModel mapping)
void	ClientScopeAdapter.updateProtocolMapper(ProtocolMapperModel mapping)

Uses of ProtocolMapperModel in org.keycloak.models.cache.infinispan.entities

Fields in org.keycloak.models.cache.infinispan.entities with type parameters of type ProtocolMapperModel

Modifier and Type	Field	Description
protected Set<ProtocolMapperModel>	CachedClient.protocolMappers

Methods in org.keycloak.models.cache.infinispan.entities that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Set<ProtocolMapperModel>	CachedClient.getProtocolMappers()
Set<ProtocolMapperModel>	CachedClientScope.getProtocolMappers()

Uses of ProtocolMapperModel in org.keycloak.models.delegate

Methods in org.keycloak.models.delegate that return ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientModelLazyDelegate.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientModelLazyDelegate.getProtocolMapperById(String id)
ProtocolMapperModel	ClientModelLazyDelegate.getProtocolMapperByName(String protocol, String name)

Methods in org.keycloak.models.delegate that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Stream<ProtocolMapperModel>	ClientModelLazyDelegate.getProtocolMappersStream()

Methods in org.keycloak.models.delegate with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientModelLazyDelegate.addProtocolMapper(ProtocolMapperModel model)
void	ClientModelLazyDelegate.removeProtocolMapper(ProtocolMapperModel mapping)
void	ClientModelLazyDelegate.updateProtocolMapper(ProtocolMapperModel mapping)

Uses of ProtocolMapperModel in org.keycloak.models.jpa

Methods in org.keycloak.models.jpa that return ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
protected ProtocolMapperModel	ClientAdapter.entityToModel(ProtocolMapperEntity entity)
protected ProtocolMapperModel	ClientScopeAdapter.entityToModel(ProtocolMapperEntity entity)
ProtocolMapperModel	ClientAdapter.getProtocolMapperById(String id)
ProtocolMapperModel	ClientScopeAdapter.getProtocolMapperById(String id)
ProtocolMapperModel	ClientAdapter.getProtocolMapperByName(String protocol, String name)
ProtocolMapperModel	ClientScopeAdapter.getProtocolMapperByName(String protocol, String name)

Methods in org.keycloak.models.jpa that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Stream<ProtocolMapperModel>	ClientAdapter.getProtocolMappersStream()
Stream<ProtocolMapperModel>	ClientScopeAdapter.getProtocolMappersStream()

Methods in org.keycloak.models.jpa with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	ClientAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	ClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
void	JpaUserProvider.preRemove(ProtocolMapperModel protocolMapper)
void	ClientAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	ClientScopeAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	ClientAdapter.updateProtocolMapper(ProtocolMapperModel mapping)
void	ClientScopeAdapter.updateProtocolMapper(ProtocolMapperModel mapping)

Uses of ProtocolMapperModel in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	RepresentationToModel.toModel(ProtocolMapperRepresentation rep)

Methods in org.keycloak.models.utils with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperRepresentation	ModelToRepresentation.toRepresentation(ProtocolMapperModel model)

Uses of ProtocolMapperModel in org.keycloak.organization.protocol.mappers.oidc

Methods in org.keycloak.organization.protocol.mappers.oidc that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	OrganizationMembershipMapper.create(String name, boolean accessToken, boolean idToken, boolean introspectionEndpoint)

Methods in org.keycloak.organization.protocol.mappers.oidc with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
protected void	OrganizationMembershipMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)

Uses of ProtocolMapperModel in org.keycloak.organization.protocol.mappers.saml

Methods in org.keycloak.organization.protocol.mappers.saml that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	OrganizationMembershipMapper.create()

Methods in org.keycloak.organization.protocol.mappers.saml with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
void	OrganizationMembershipMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

Uses of ProtocolMapperModel in org.keycloak.protocol

Methods in org.keycloak.protocol that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	ProtocolMapperUtils.findLocaleMapper(KeycloakSession session)	Find the builtin locale mapper.
default ProtocolMapperModel	ProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)	Get effective configuration of protocol mapper.

Methods in org.keycloak.protocol that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	LoginProtocolFactory.getBuiltinMappers()	List of built in protocol mappers that can be used to apply to clients.
static Stream<Map.Entry<ProtocolMapperModel,ProtocolMapper>>	ProtocolMapperUtils.getSortedProtocolMappers(KeycloakSession session, ClientSessionContext ctx)
static Stream<Map.Entry<ProtocolMapperModel,ProtocolMapper>>	ProtocolMapperUtils.getSortedProtocolMappers(KeycloakSession session, ClientSessionContext ctx, Predicate<Map.Entry<ProtocolMapperModel,ProtocolMapper>> filter)

Methods in org.keycloak.protocol with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
default ProtocolMapperModel	ProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)	Get effective configuration of protocol mapper.
static boolean	ProtocolMapperUtils.isEnabled(KeycloakSession session, ProtocolMapperModel mapper)
default void	ProtocolMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)	Called when instance of mapperModel is created/updated for this protocolMapper through admin endpoint

Method parameters in org.keycloak.protocol with type arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
static int	ProtocolMapperUtils.compare(Map.Entry<ProtocolMapperModel,ProtocolMapper> entry)
static Stream<Map.Entry<ProtocolMapperModel,ProtocolMapper>>	ProtocolMapperUtils.getSortedProtocolMappers(KeycloakSession session, ClientSessionContext ctx, Predicate<Map.Entry<ProtocolMapperModel,ProtocolMapper>> filter)

Uses of ProtocolMapperModel in org.keycloak.protocol.docker

Methods in org.keycloak.protocol.docker that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	DockerAuthV2ProtocolFactory.getBuiltinMappers()

Uses of ProtocolMapperModel in org.keycloak.protocol.docker.mapper

Methods in org.keycloak.protocol.docker.mapper with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
DockerResponseToken	AllowAllDockerProtocolMapper.transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
DockerResponseToken	DockerAuthV2AttributeMapper.transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

Uses of ProtocolMapperModel in org.keycloak.protocol.oid4vc

Methods in org.keycloak.protocol.oid4vc that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	OID4VCLoginProtocolFactory.getBuiltinMappers()

Uses of ProtocolMapperModel in org.keycloak.protocol.oid4vc.issuance.mappers

Fields in org.keycloak.protocol.oid4vc.issuance.mappers declared as ProtocolMapperModel

Modifier and Type	Field	Description
protected ProtocolMapperModel	OID4VCMapper.mapperModel

Methods in org.keycloak.protocol.oid4vc.issuance.mappers that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	OID4VCSubjectIdMapper.create(String name, String subjectId)
static ProtocolMapperModel	OID4VCTargetRoleMapper.create(String clientId, String name)
static ProtocolMapperModel	OID4VCUserAttributeMapper.create(String mapperName, String userAttribute, String propertyName, boolean aggregateAttributes)

Methods in org.keycloak.protocol.oid4vc.issuance.mappers with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
OID4VCMapper	OID4VCMapper.setMapperModel(ProtocolMapperModel mapperModel)

Uses of ProtocolMapperModel in org.keycloak.protocol.oidc

Methods in org.keycloak.protocol.oidc that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	OIDCLoginProtocolFactory.getBuiltinMappers()

Uses of ProtocolMapperModel in org.keycloak.protocol.oidc.mappers

Methods in org.keycloak.protocol.oidc.mappers that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	AcrProtocolMapper.create(String name, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	AmrProtocolMapper.create(String name, boolean accessToken, boolean idToken)
static ProtocolMapperModel	FullNameMapper.create(String name, boolean accessToken, boolean idToken, boolean userInfo, boolean introspectionEndpoint)
static ProtocolMapperModel	GroupMembershipMapper.create(String name, String tokenClaimName, boolean consentRequired, String consentText, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	HardcodedClaim.create(String name, String hardcodedName, String hardcodedValue, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	HardcodedRole.create(String name, String role)
static ProtocolMapperModel	NonceBackwardsCompatibleMapper.create(String name)
static ProtocolMapperModel	RoleNameMapper.create(String name, String role, String newName)
static ProtocolMapperModel	ScriptBasedOIDCProtocolMapper.create(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, String script, boolean multiValued)
static ProtocolMapperModel	SessionStateMapper.create(String name, boolean accessToken, boolean idToken, boolean userInfo, boolean introspectionEndpoint)
static ProtocolMapperModel	SubMapper.create(String name, boolean accessToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserClientRoleMappingMapper.create(String clientId, String clientRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserClientRoleMappingMapper.create(String clientId, String clientRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean introspectionEndpoint, boolean multiValued)
static ProtocolMapperModel	UserRealmRoleMappingMapper.create(String realmRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserRealmRoleMappingMapper.create(String realmRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean introspectionEndpoint, boolean multiValued)
static ProtocolMapperModel	AddressMapper.createAddressMapper()
static ProtocolMapperModel	AddressMapper.createAddressMapper(boolean idToken, boolean accessToken, boolean userInfo, boolean introspectionEndpoint)
static ProtocolMapperModel	AllowedWebOriginsProtocolMapper.createClaimMapper(String name, boolean accessToken, boolean introspectionEndpoint)
static ProtocolMapperModel	AudienceProtocolMapper.createClaimMapper(String name, String includedClientAudience, String includedCustomAudience, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	AudienceResolveProtocolMapper.createClaimMapper(String name, boolean accessToken, boolean introspectionEndpoint)
static ProtocolMapperModel	OIDCAttributeMapperHelper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean userinfo, boolean introspectionEndpoint, String mapperId)
static ProtocolMapperModel	OIDCAttributeMapperHelper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, String mapperId)
static ProtocolMapperModel	UserAttributeMapper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserAttributeMapper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, boolean multivalued)
static ProtocolMapperModel	UserAttributeMapper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, boolean multivalued, boolean aggregateAttrs)
static ProtocolMapperModel	UserPropertyMapper.createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserSessionNoteMapper.createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
static ProtocolMapperModel	UserSessionNoteMapper.createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken, boolean userInfo, boolean introspectionEndpoint)
static ProtocolMapperModel	ClaimsParameterTokenMapper.createMapper(String name, boolean idToken, boolean userInfo)
static ProtocolMapperModel	ClaimsParameterWithValueIdTokenMapper.createMapper(String name, String attributeValue, boolean idToken)
static ProtocolMapperModel	UserSessionNoteMapper.createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)	For session notes defined using a UserSessionNoteDescriptor enum
ProtocolMapperModel	AbstractOIDCProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)
ProtocolMapperModel	AllowedWebOriginsProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)
ProtocolMapperModel	AudienceResolveProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)

Methods in org.keycloak.protocol.oidc.mappers with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
abstract String	AbstractPairwiseSubMapper.generateSub(ProtocolMapperModel mappingModel, String sectorIdentifier, String localSub)	Generates a pairwise subject identifier.
String	SHA256PairwiseSubMapper.generateSub(ProtocolMapperModel mappingModel, String sectorIdentifier, String localSub)
ProtocolMapperModel	AbstractOIDCProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)
ProtocolMapperModel	AllowedWebOriginsProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)
ProtocolMapperModel	AudienceResolveProtocolMapper.getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel protocolMapperModel)
static String	PairwiseSubMapperHelper.getSalt(ProtocolMapperModel mappingModel)
protected String	DeployedScriptOIDCProtocolMapper.getScriptCode(ProtocolMapperModel mapperModel)
protected String	ScriptBasedOIDCProtocolMapper.getScriptCode(ProtocolMapperModel mapperModel)
static String	PairwiseSubMapperHelper.getSectorIdentifierUri(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInAccessToken(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInAccessTokenResponse(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInIDToken(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInIntrospection(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInLightweightAccessToken(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.includeInUserInfo(ProtocolMapperModel mappingModel)
static boolean	OIDCAttributeMapperHelper.isMultivalued(ProtocolMapperModel mappingModel)
static Object	OIDCAttributeMapperHelper.mapAttributeValue(ProtocolMapperModel mappingModel, Object attributeValue)
static void	OIDCAttributeMapperHelper.mapClaim(AccessTokenResponse token, ProtocolMapperModel mappingModel, Object attributeValue)
static void	OIDCAttributeMapperHelper.mapClaim(IDToken token, ProtocolMapperModel mappingModel, Object attributeValue)
protected void	AbstractOIDCProtocolMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Deprecated. override AbstractOIDCProtocolMapper.setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext) instead.
protected void	AbstractOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.
protected void	AcrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AddressMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	AmrProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	AudienceProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ClaimsParameterWithValueIdTokenMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	FullNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	GroupMembershipMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)	Adds the group membership information to the JsonWebToken.otherClaims.
protected void	HardcodedClaim.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	HardcodedClaim.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	HardcodedRole.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	RoleNameMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	ScriptBasedOIDCProtocolMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	ScriptBasedOIDCProtocolMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SessionStateMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	SubMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	UserAttributeMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserClientRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserPropertyMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
protected void	UserRealmRoleMappingMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)
protected void	UserSessionNoteMapper.setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)
protected void	UserSessionNoteMapper.setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)
static void	PairwiseSubMapperHelper.setSalt(ProtocolMapperModel mappingModel, String salt)
static void	PairwiseSubMapperHelper.setSectorIdentifierUri(ProtocolMapperModel mappingModel, String sectorIdentifierUri)
AccessToken	AbstractOIDCProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AllowedWebOriginsProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AudienceResolveProtocolMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	NonceBackwardsCompatibleMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	OIDCAccessTokenMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	AbstractOIDCProtocolMapper.transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessTokenResponse	OIDCAccessTokenResponseMapper.transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractOIDCProtocolMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	AbstractPairwiseSubMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
IDToken	OIDCIDTokenMapper.transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)
AccessToken	AbstractOIDCProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AllowedWebOriginsProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AudienceResolveProtocolMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	TokenIntrospectionTokenMapper.transformIntrospectionToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractOIDCProtocolMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	AbstractPairwiseSubMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	HardcodedRole.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	RoleNameMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
AccessToken	UserInfoTokenMapper.transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
static boolean	GroupMembershipMapper.useFullPath(ProtocolMapperModel mappingModel)
void	AbstractPairwiseSubMapper.validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel)	Override to add additional configuration validation.
void	SHA256PairwiseSubMapper.validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel)
final void	AbstractPairwiseSubMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel)
void	ScriptBasedOIDCProtocolMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)

Uses of ProtocolMapperModel in org.keycloak.protocol.oidc.utils

Methods in org.keycloak.protocol.oidc.utils with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
static void	PairwiseSubMapperValidator.validate(KeycloakSession session, ClientModel client, ProtocolMapperModel mapperModel)

Uses of ProtocolMapperModel in org.keycloak.protocol.saml

Fields in org.keycloak.protocol.saml declared as ProtocolMapperModel

Modifier and Type	Field	Description
final ProtocolMapperModel	SamlProtocol.ProtocolMapperProcessor.model

Methods in org.keycloak.protocol.saml that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	SamlProtocolFactory.getBuiltinMappers()

Constructors in org.keycloak.protocol.saml with parameters of type ProtocolMapperModel

Modifier	Constructor	Description
	ProtocolMapperProcessor(T mapper, ProtocolMapperModel model)

Uses of ProtocolMapperModel in org.keycloak.protocol.saml.mappers

Methods in org.keycloak.protocol.saml.mappers that return ProtocolMapperModel

Modifier and Type	Method	Description
static ProtocolMapperModel	GroupMembershipMapper.create(String name, String samlAttributeName, String nameFormat, String friendlyName, boolean singleAttribute)
static ProtocolMapperModel	HardcodedAttributeMapper.create(String name, String samlAttributeName, String nameFormat, String friendlyName, String value)
static ProtocolMapperModel	HardcodedRole.create(String name, String role)
static ProtocolMapperModel	RoleListMapper.create(String name, String samlAttributeName, String nameFormat, String friendlyName, boolean singleAttribute)
static ProtocolMapperModel	RoleNameMapper.create(String name, String role, String newName)
static ProtocolMapperModel	ScriptBasedMapper.create(String name, String samlAttributeName, String nameFormat, String friendlyName, String script, boolean singleAttribute)	Creates an protocol mapper model for the this script based mapper.
static ProtocolMapperModel	AttributeStatementHelper.createAttributeMapper(String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, String mapperId)
static ProtocolMapperModel	UserAttributeStatementMapper.createAttributeMapper(String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName)
static ProtocolMapperModel	UserPropertyAttributeStatementMapper.createAttributeMapper(String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, boolean consentRequired, String consentText)

Methods in org.keycloak.protocol.saml.mappers with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
static void	AttributeStatementHelper.addAttribute(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, String attributeValue)
static void	AttributeStatementHelper.addAttributes(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, Collection<String> attributeValues)
static AttributeType	AttributeStatementHelper.createAttributeType(ProtocolMapperModel mappingModel)
protected String	DeployedScriptSAMLProtocolMapper.getScriptCode(ProtocolMapperModel mapperModel)
protected String	ScriptBasedMapper.getScriptCode(ProtocolMapperModel mappingModel)
String	RoleNameMapper.mapName(ProtocolMapperModel model, RoleModel roleModel)
String	SAMLGroupNameMapper.mapName(ProtocolMapperModel model, GroupModel group)
String	SAMLRoleNameMapper.mapName(ProtocolMapperModel model, RoleModel role)
String	SAMLNameIdMapper.mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
String	UserAttributeNameIdMapper.mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	RoleListMapper.mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
void	SAMLRoleListMapper.mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
void	GroupMembershipMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	HardcodedAttributeMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	SAMLAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	ScriptBasedMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)	This method attaches one or many attributes to the passed attribute statement.
void	UserAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	UserPropertyAttributeStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
void	UserSessionNoteStatementMapper.transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)
ResponseType	SAMLAudienceProtocolMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
ResponseType	SAMLAudienceResolveProtocolMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
ResponseType	SAMLLoginResponseMapper.transformLoginResponse(ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)
static boolean	GroupMembershipMapper.useFullPath(ProtocolMapperModel mappingModel)
void	ScriptBasedMapper.validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)

Uses of ProtocolMapperModel in org.keycloak.services.migration

Methods in org.keycloak.services.migration that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Map<String,ProtocolMapperModel>	DefaultMigrationProvider.getBuiltinMappers(String protocol)

Uses of ProtocolMapperModel in org.keycloak.services.util

Methods in org.keycloak.services.util that return types with arguments of type ProtocolMapperModel

Modifier and Type	Method	Description
Stream<ProtocolMapperModel>	DefaultClientSessionContext.getProtocolMappersStream()

Uses of ProtocolMapperModel in org.keycloak.storage

Methods in org.keycloak.storage with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
void	UserStorageManager.preRemove(ProtocolMapperModel protocolMapper)

Uses of ProtocolMapperModel in org.keycloak.storage.client

Methods in org.keycloak.storage.client that return ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	AbstractReadOnlyClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	AbstractReadOnlyClientStorageAdapter.addProtocolMapper(ProtocolMapperModel model)

Methods in org.keycloak.storage.client with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
ProtocolMapperModel	AbstractReadOnlyClientScopeAdapter.addProtocolMapper(ProtocolMapperModel model)
ProtocolMapperModel	AbstractReadOnlyClientStorageAdapter.addProtocolMapper(ProtocolMapperModel model)
void	AbstractReadOnlyClientScopeAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	AbstractReadOnlyClientStorageAdapter.removeProtocolMapper(ProtocolMapperModel mapping)
void	AbstractReadOnlyClientScopeAdapter.updateProtocolMapper(ProtocolMapperModel mapping)
void	AbstractReadOnlyClientStorageAdapter.updateProtocolMapper(ProtocolMapperModel mapping)

Uses of ProtocolMapperModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
void	UserFederatedStorageProvider.preRemove(ProtocolMapperModel protocolMapper)

Uses of ProtocolMapperModel in org.keycloak.storage.jpa

Methods in org.keycloak.storage.jpa with parameters of type ProtocolMapperModel

Modifier and Type	Method	Description
void	JpaUserFederatedStorageProvider.preRemove(ProtocolMapperModel protocolMapper)