Uses of Interface
org.keycloak.protocol.ProtocolMapper

Packages that use ProtocolMapper

Package	Description
org.keycloak.organization.protocol.mappers.oidc
org.keycloak.organization.protocol.mappers.saml
org.keycloak.protocol
org.keycloak.protocol.docker.mapper
org.keycloak.protocol.oid4vc.issuance.mappers
org.keycloak.protocol.oidc.mappers
org.keycloak.protocol.saml.mappers
org.keycloak.services.util

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

Classes in org.keycloak.organization.protocol.mappers.oidc that implement ProtocolMapper

Modifier and Type	Class	Description
class	OrganizationMembershipMapper

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

Classes in org.keycloak.organization.protocol.mappers.saml that implement ProtocolMapper

Modifier and Type	Class	Description
class	OrganizationMembershipMapper

Uses of ProtocolMapper in org.keycloak.protocol

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

Modifier and Type	Method	Description
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)

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

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 ProtocolMapper in org.keycloak.protocol.docker.mapper

Classes in org.keycloak.protocol.docker.mapper that implement ProtocolMapper

Modifier and Type	Class	Description
class	AllowAllDockerProtocolMapper	Populates token with requested scope.
class	DockerAuthV2ProtocolMapper

Methods in org.keycloak.protocol.docker.mapper that return ProtocolMapper

Modifier and Type	Method	Description
final ProtocolMapper	DockerAuthV2ProtocolMapper.create(KeycloakSession session)

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

Classes in org.keycloak.protocol.oid4vc.issuance.mappers that implement ProtocolMapper

Modifier and Type	Class	Description
class	OID4VCContextMapper	Allows to add the context to the credential subject
class	OID4VCGeneratedIdMapper	Adds a generated ID to the credential (as a configurable property).
class	OID4VCIssuedAtTimeClaimMapper	Map issuance date to the credential, under the default claim name "iat"
class	OID4VCMapper	Base class for OID4VC Mappers, to provide common configuration and functionality for all of them
class	OID4VCStaticClaimMapper	Allows to add statically configured claims to the credential subject
class	OID4VCSubjectIdMapper	Sets an ID for the credential, either randomly generated or statically configured
class	OID4VCTargetRoleMapper	Adds the users roles to the credential subject
class	OID4VCTypeMapper	Allows to add types to the credential subject
class	OID4VCUserAttributeMapper	Allows to add user attributes to the credential subject

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

Modifier and Type	Method	Description
ProtocolMapper	OID4VCContextMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCGeneratedIdMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCIssuedAtTimeClaimMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCStaticClaimMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCSubjectIdMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCTargetRoleMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCTypeMapper.create(KeycloakSession session)
ProtocolMapper	OID4VCUserAttributeMapper.create(KeycloakSession session)

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

Classes in org.keycloak.protocol.oidc.mappers that implement ProtocolMapper

Modifier and Type	Class	Description
class	AbstractOIDCProtocolMapper
class	AbstractPairwiseSubMapper	Set the 'sub' claim to pairwise .
class	AbstractUserRoleMappingMapper	Base class for mapping of user role mappings to an ID and Access Token claim.
class	AcrProtocolMapper
class	AddressMapper
class	AllowedWebOriginsProtocolMapper	Protocol mapper to add allowed web origins to the access token to the 'allowed-origins' claim
class	AmrProtocolMapper
class	AudienceProtocolMapper
class	AudienceResolveProtocolMapper	Protocol mapper, which adds all client_ids of "allowed" clients to the audience field of the token.
class	ClaimsParameterTokenMapper
class	ClaimsParameterWithValueIdTokenMapper
class	DeployedScriptOIDCProtocolMapper
class	FullNameMapper	Set the 'name' claim to be first + last name.
class	GroupMembershipMapper	Maps user group membership
class	HardcodedClaim
class	HardcodedRole	Add a role to a token
class	NonceBackwardsCompatibleMapper	Simple mapper that adds the nonce claim into the access token as before.
class	RoleNameMapper	Map an assigned role to a different position and name in the token
class	ScriptBasedOIDCProtocolMapper	OIDC ProtocolMapper that uses a provided JavaScript fragment to compute the token claim value.
class	SessionStateMapper
class	SHA256PairwiseSubMapper
class	SubMapper
class	UserAttributeMapper	Mappings UserModel.attribute to an ID Token claim.
class	UserClientRoleMappingMapper	Allows mapping of user client role mappings to an ID and Access Token claim.
class	UserPropertyMapper	Mappings UserModel property (the property name of a getter method) to an ID Token claim.
class	UserRealmRoleMappingMapper	Allows mapping of user realm role mappings to an ID and Access Token claim.
class	UserSessionNoteMapper	Mappings UserSessionModel.note to an ID Token claim.

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

Modifier and Type	Method	Description
final ProtocolMapper	AbstractOIDCProtocolMapper.create(KeycloakSession session)
final ProtocolMapper	NonceBackwardsCompatibleMapper.create(KeycloakSession session)

Method parameters in org.keycloak.protocol.oidc.mappers with type arguments of type ProtocolMapper

Modifier and Type	Method	Description
static void	OIDCAttributeMapperHelper.addAttributeConfig(List<ProviderConfigProperty> configProperties, Class<? extends ProtocolMapper> protocolMapperClass)
static void	OIDCAttributeMapperHelper.addIncludeInTokensConfig(List<ProviderConfigProperty> configProperties, Class<? extends ProtocolMapper> protocolMapperClass)

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

Classes in org.keycloak.protocol.saml.mappers that implement ProtocolMapper

Modifier and Type	Class	Description
class	AbstractSAMLProtocolMapper
class	DeployedScriptSAMLProtocolMapper
class	GroupMembershipMapper
class	HardcodedAttributeMapper	Mappings UserModel property (the property name of a getter method) to an AttributeStatement.
class	HardcodedRole	Mappings UserModel property (the property name of a getter method) to an AttributeStatement.
class	RoleListMapper
class	RoleNameMapper	Map an assigned role to a different position and name in the token
class	SAMLAudienceProtocolMapper	SAML mapper to add a audience restriction into the assertion, to another client (clientId) or to a custom URI.
class	SAMLAudienceResolveProtocolMapper	SAML audience resolve mapper.
class	ScriptBasedMapper	This class provides a mapper that uses javascript to attach a value to an attribute for SAML tokens.
class	UserAttributeNameIdMapper
class	UserAttributeStatementMapper	Mappings UserModel attribute (not property name of a getter method) to an AttributeStatement.
class	UserPropertyAttributeStatementMapper	Mappings UserModel property (the property name of a getter method) to an AttributeStatement.
class	UserSessionNoteStatementMapper	Maps a user session note to a SAML attribute

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

Modifier and Type	Method	Description
final ProtocolMapper	AbstractSAMLProtocolMapper.create(KeycloakSession session)
final ProtocolMapper	RoleNameMapper.create(KeycloakSession session)

Uses of ProtocolMapper in org.keycloak.services.util

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

Modifier and Type	Method	Description
static Stream<Map.Entry<ProtocolMapperModel,ProtocolMapper>>	DPoPUtil.getTransientProtocolMapper()	creates a protocol mapper that cannot be modified by administration users and that is used to bind AccessTokens to specific DPoP keys.