## 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.jpa |
  org.keycloak.models.map.client |
  org.keycloak.models.map.clientscope |
  org.keycloak.models.map.user |
  org.keycloak.models.utils |
  org.keycloak.protocol |
  org.keycloak.protocol.docker |
  org.keycloak.protocol.docker.mapper |
  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 |
  org.keycloak.storage.openshift |

- - ### Uses of ProtocolMapperModel in org.keycloak.migration

    Methods in org.keycloak.migration that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and 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 and 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 and 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 and Description
    --- | ---
    `default Set<ProtocolMapperModel>` | ProtocolMapperContainerModel.`getProtocolMappers()` Deprecated. Use `getProtocolMappersStream` instead.
    `default Set<ProtocolMapperModel>` | ClientSessionContext.`getProtocolMappers()` Deprecated. Use `getProtocolMappersStream` instead.
    `Stream<ProtocolMapperModel>` | ProtocolMapperContainerModel.`getProtocolMappersStream()` Returns protocol mappers as a stream.
    `Stream<ProtocolMapperModel>` | ClientSessionContext.`getProtocolMappersStream()` Returns protocol mappers as a stream.

    Methods in org.keycloak.models with parameters of type ProtocolMapperModel
    Modifier and Type | Method and 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 and Description
    --- | ---
    `ProtocolMapperModel` | ClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | ClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | ClientScopeAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | ClientAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | ClientScopeAdapter.`getProtocolMapperByName(String protocol, String name)`
    `ProtocolMapperModel` | ClientAdapter.`getProtocolMapperByName(String protocol, String name)`

    Methods in org.keycloak.models.cache.infinispan that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<ProtocolMapperModel>` | ClientScopeAdapter.`getProtocolMappersStream()`
    `Stream<ProtocolMapperModel>` | ClientAdapter.`getProtocolMappersStream()`

    Methods in org.keycloak.models.cache.infinispan with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | ClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | ClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | UserCacheSession.`preRemove(ProtocolMapperModel protocolMapper)`
    `void` | ClientScopeAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientScopeAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientAdapter.`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 and 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 and Description
    --- | ---
    `Set<ProtocolMapperModel>` | CachedClientScope.`getProtocolMappers()`
    `Set<ProtocolMapperModel>` | CachedClient.`getProtocolMappers()`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.jpa

    Methods in org.keycloak.models.jpa that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | ClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | ClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `protected ProtocolMapperModel` | ClientScopeAdapter.`entityToModel(ProtocolMapperEntity entity)`
    `protected ProtocolMapperModel` | ClientAdapter.`entityToModel(ProtocolMapperEntity entity)`
    `ProtocolMapperModel` | ClientScopeAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | ClientAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | ClientScopeAdapter.`getProtocolMapperByName(String protocol, String name)`
    `ProtocolMapperModel` | ClientAdapter.`getProtocolMapperByName(String protocol, String name)`

    Methods in org.keycloak.models.jpa that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<ProtocolMapperModel>` | ClientScopeAdapter.`getProtocolMappersStream()`
    `Stream<ProtocolMapperModel>` | ClientAdapter.`getProtocolMappersStream()`

    Methods in org.keycloak.models.jpa with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | ClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | ClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | JpaUserProvider.`preRemove(ProtocolMapperModel protocolMapper)`
    `void` | ClientScopeAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientScopeAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.map.client

    Methods in org.keycloak.models.map.client that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | MapClientEntity.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientEntity.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | MapClientAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | MapClientAdapter.`getProtocolMapperByName(String protocol, String name)`

    Methods in org.keycloak.models.map.client that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Collection<ProtocolMapperModel>` | MapClientEntity.`getProtocolMappers()`
    `Stream<ProtocolMapperModel>` | MapClientAdapter.`getProtocolMappersStream()` Protocol mappers

    Methods in org.keycloak.models.map.client with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | MapClientEntity.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | MapClientAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | MapClientAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`
    `void` | MapClientEntity.`updateProtocolMapper(String id, ProtocolMapperModel mapping)`

    Method parameters in org.keycloak.models.map.client with type arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MapClientEntity.`setProtocolMappers(Collection<ProtocolMapperModel> protocolMappers)`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.map.clientscope

    Methods in org.keycloak.models.map.clientscope that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | MapClientScopeEntity.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientScopeEntity.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | MapClientScopeAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | MapClientScopeAdapter.`getProtocolMapperByName(String protocol, String name)`

    Methods in org.keycloak.models.map.clientscope that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<ProtocolMapperModel>` | MapClientScopeEntity.`getProtocolMappers()`
    `Stream<ProtocolMapperModel>` | MapClientScopeAdapter.`getProtocolMappersStream()`

    Methods in org.keycloak.models.map.clientscope with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | MapClientScopeEntity.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | MapClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | MapClientScopeAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | MapClientScopeAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`
    `void` | MapClientScopeEntity.`updateProtocolMapper(String id, ProtocolMapperModel mapping)`

    Method parameters in org.keycloak.models.map.clientscope with type arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MapClientScopeEntity.`setProtocolMappers(Collection<ProtocolMapperModel> protocolMappers)`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.map.user

    Methods in org.keycloak.models.map.user with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | MapUserProvider.`preRemove(ProtocolMapperModel protocolMapper)`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.utils

    Methods in org.keycloak.models.utils that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static ProtocolMapperModel` | RepresentationToModel.`toModel(ProtocolMapperRepresentation rep)`

    Methods in org.keycloak.models.utils with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static ProtocolMapperRepresentation` | ModelToRepresentation.`toRepresentation(ProtocolMapperModel model)`

  - ### Uses of ProtocolMapperModel in org.keycloak.protocol

    Methods in org.keycloak.protocol that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static ProtocolMapperModel` | ProtocolMapperUtils.`findLocaleMapper(KeycloakSession session)` Find the builtin locale mapper.

    Methods in org.keycloak.protocol that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and 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)`

    Methods in org.keycloak.protocol with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `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 and Description
    --- | ---
    `static int` | ProtocolMapperUtils.`compare(Map.Entry<ProtocolMapperModel,ProtocolMapper> entry)`

  - ### 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 and 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 and Description
    --- | ---
    `DockerResponseToken` | DockerAuthV2AttributeMapper.`transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)`
    `DockerResponseToken` | AllowAllDockerProtocolMapper.`transformDockerResponseToken(DockerResponseToken responseToken, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)`

  - ### 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 and 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 and Description
    --- | ---
    `static ProtocolMapperModel` | FullNameMapper.`create(String name, boolean accessToken, boolean idToken, boolean userInfo)`
    `static ProtocolMapperModel` | HardcodedRole.`create(String name, String role)`
    `static ProtocolMapperModel` | GroupMembershipMapper.`create(String name, String tokenClaimName, boolean consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | RoleNameMapper.`create(String name, String role, String newName)`
    `static ProtocolMapperModel` | UserRealmRoleMappingMapper.`create(String realmRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserRealmRoleMappingMapper.`create(String realmRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean multiValued)`
    `static ProtocolMapperModel` | UserClientRoleMappingMapper.`create(String clientId, String clientRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | HardcodedClaim.`create(String name, String hardcodedName, String hardcodedValue, String claimType, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserClientRoleMappingMapper.`create(String clientId, String clientRolePrefix, String name, String tokenClaimName, boolean accessToken, boolean idToken, boolean multiValued)`
    `static ProtocolMapperModel` | ScriptBasedOIDCProtocolMapper.`create(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, String script, boolean multiValued)`
    `static ProtocolMapperModel` | AddressMapper.`createAddressMapper()`
    `static ProtocolMapperModel` | AddressMapper.`createAddressMapper(boolean idToken, boolean accessToken, boolean userInfo)`
    `static ProtocolMapperModel` | AudienceResolveProtocolMapper.`createClaimMapper(String name)`
    `static ProtocolMapperModel` | AllowedWebOriginsProtocolMapper.`createClaimMapper(String name)`
    `static ProtocolMapperModel` | AudienceProtocolMapper.`createClaimMapper(String name, String includedClientAudience, String includedCustomAudience, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserSessionNoteMapper.`createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserPropertyMapper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserAttributeMapper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean multivalued)`
    `static ProtocolMapperModel` | UserAttributeMapper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean multivalued, boolean aggregateAttrs)`
    `static ProtocolMapperModel` | OIDCAttributeMapperHelper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean userinfo, String mapperId)`
    `static ProtocolMapperModel` | OIDCAttributeMapperHelper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, String mapperId)`
    `static ProtocolMapperModel` | ClaimsParameterTokenMapper.`createMapper(String name, boolean idToken, boolean userInfo)`
    `static ProtocolMapperModel` | UserSessionNoteMapper.`createUserSessionNoteMapper(UserSessionNoteDescriptor userSessionNoteDescriptor)` For session notes defined using a `UserSessionNoteDescriptor` enum

    Methods in org.keycloak.protocol.oidc.mappers with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `String` | SHA256PairwiseSubMapper.`generateSub(ProtocolMapperModel mappingModel, String sectorIdentifier, String localSub)`
    `abstract String` | AbstractPairwiseSubMapper.`generateSub(ProtocolMapperModel mappingModel, String sectorIdentifier, String localSub)` Generates a pairwise subject identifier.
    `static String` | PairwiseSubMapperHelper.`getSalt(ProtocolMapperModel mappingModel)`
    `protected String` | ScriptBasedOIDCProtocolMapper.`getScriptCode(ProtocolMapperModel mapperModel)`
    `protected String` | DeployedScriptOIDCProtocolMapper.`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.`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` | UserSessionNoteMapper.`setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `protected void` | ScriptBasedOIDCProtocolMapper.`setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `protected void` | HardcodedClaim.`setClaim(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `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` | UserSessionNoteMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserPropertyMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserAttributeMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | HardcodedClaim.`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` | FullNameMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | AddressMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | AbstractOIDCProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)` Deprecated. override `AbstractOIDCProtocolMapper.setClaim(IDToken, ProtocolMapperModel, UserSessionModel, KeycloakSession, ClientSessionContext)` instead.
    `protected void` | UserRealmRoleMappingMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)`
    `protected void` | UserClientRoleMappingMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)`
    `protected void` | ScriptBasedOIDCProtocolMapper.`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` | AudienceProtocolMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession, KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx)`
    `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.
    `static void` | PairwiseSubMapperHelper.`setSalt(ProtocolMapperModel mappingModel, String salt)`
    `static void` | PairwiseSubMapperHelper.`setSectorIdentifierUri(ProtocolMapperModel mappingModel, String sectorIdentifierUri)`
    `AccessToken` | RoleNameMapper.`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` | HardcodedRole.`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` | AllowedWebOriginsProtocolMapper.`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` | AbstractOIDCProtocolMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `AccessTokenResponse` | OIDCAccessTokenResponseMapper.`transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `AccessTokenResponse` | AbstractOIDCProtocolMapper.`transformAccessTokenResponse(AccessTokenResponse accessTokenResponse, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `IDToken` | OIDCIDTokenMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSession)`
    `IDToken` | AbstractPairwiseSubMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `IDToken` | AbstractOIDCProtocolMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `AccessToken` | UserInfoTokenMapper.`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` | AbstractOIDCProtocolMapper.`transformUserInfoToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `static boolean` | GroupMembershipMapper.`useFullPath(ProtocolMapperModel mappingModel)`
    `void` | SHA256PairwiseSubMapper.`validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel)`
    `void` | AbstractPairwiseSubMapper.`validateAdditionalConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, ProtocolMapperModel mapperModel)` Override to add additional configuration validation.
    `void` | ScriptBasedOIDCProtocolMapper.`validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel client, ProtocolMapperModel mapperModel)`
    `void` | AbstractPairwiseSubMapper.`validateConfig(KeycloakSession session, RealmModel realm, ProtocolMapperContainerModel mapperContainer, 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 and 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 and Description
    --- | ---
    `ProtocolMapperModel` | SamlProtocol.ProtocolMapperProcessor.`model`

    Methods in org.keycloak.protocol.saml that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,ProtocolMapperModel>` | SamlProtocolFactory.`getBuiltinMappers()`

    Constructors in org.keycloak.protocol.saml with parameters of type ProtocolMapperModel
    Constructor and 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 and Description
    --- | ---
    `static ProtocolMapperModel` | HardcodedRole.`create(String name, String role)`
    `static ProtocolMapperModel` | RoleNameMapper.`create(String name, String role, String newName)`
    `static ProtocolMapperModel` | RoleListMapper.`create(String name, String samlAttributeName, String nameFormat, String friendlyName, boolean singleAttribute)`
    `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` | 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` | 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)`
    `static ProtocolMapperModel` | AttributeStatementHelper.`createAttributeMapper(String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, String mapperId)`

    Methods in org.keycloak.protocol.saml.mappers with parameters of type ProtocolMapperModel
    Modifier and Type | Method and 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)`
    `String` | SAMLGroupNameMapper.`mapName(ProtocolMapperModel model, GroupModel group)`
    `String` | SAMLRoleNameMapper.`mapName(ProtocolMapperModel model, RoleModel role)`
    `String` | RoleNameMapper.`mapName(ProtocolMapperModel model, RoleModel roleModel)`
    `String` | UserAttributeNameIdMapper.`mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)`
    `String` | SAMLNameIdMapper.`mapperNameId(String nameIdFormat, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)`
    `void` | SAMLRoleListMapper.`mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `void` | RoleListMapper.`mapRoles(AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx)`
    `void` | UserSessionNoteStatementMapper.`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` | UserAttributeStatementMapper.`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` | SAMLAttributeStatementMapper.`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` | GroupMembershipMapper.`transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)`
    `ResponseType` | SAMLLoginResponseMapper.`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` | SAMLAudienceProtocolMapper.`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 and 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 and 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 and 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 and Description
    --- | ---
    `ProtocolMapperModel` | AbstractReadOnlyClientStorageAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | AbstractReadOnlyClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`

    Methods in org.keycloak.storage.client with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | AbstractReadOnlyClientStorageAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `ProtocolMapperModel` | AbstractReadOnlyClientScopeAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | AbstractReadOnlyClientStorageAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | AbstractReadOnlyClientScopeAdapter.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | AbstractReadOnlyClientStorageAdapter.`updateProtocolMapper(ProtocolMapperModel mapping)`
    `void` | AbstractReadOnlyClientScopeAdapter.`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 and 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 and Description
    --- | ---
    `void` | JpaUserFederatedStorageProvider.`preRemove(ProtocolMapperModel protocolMapper)`

  - ### Uses of ProtocolMapperModel in org.keycloak.storage.openshift

    Methods in org.keycloak.storage.openshift that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | OpenshiftSAClientAdapter.`getProtocolMapperById(String id)`
    `ProtocolMapperModel` | OpenshiftSAClientAdapter.`getProtocolMapperByName(String protocol, String name)`

    Methods in org.keycloak.storage.openshift that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Stream<ProtocolMapperModel>` | OpenshiftSAClientAdapter.`getProtocolMappersStream()`

Copyright © 2021 JBoss by Red Hat. All rights reserved.