## Uses of Class
org.keycloak.models.ProtocolMapperModel

- Packages that use ProtocolMapperModel
  Package | Description
  --- | ---
  org.keycloak.models |
  org.keycloak.models.cache |
  org.keycloak.models.cache.entities |
  org.keycloak.models.file.adapter |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.utils |
  org.keycloak.protocol |
  org.keycloak.protocol.oidc |
  org.keycloak.protocol.oidc.mappers |
  org.keycloak.protocol.saml |
  org.keycloak.protocol.saml.mappers |

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

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

    Methods in org.keycloak.models that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<ProtocolMapperModel>` | ClientModel.`getProtocolMappers()`

    Methods in org.keycloak.models with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | ClientModel.`addProtocolMapper(ProtocolMapperModel model)`
    `void` | ClientModel.`removeProtocolMapper(ProtocolMapperModel mapping)`
    `void` | ClientModel.`updateProtocolMapper(ProtocolMapperModel mapping)`

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

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

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

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

  - ### Uses of ProtocolMapperModel in org.keycloak.models.cache.entities

    Methods in org.keycloak.models.cache.entities that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<ProtocolMapperModel>` | CachedClient.`getProtocolMappers()`

  - ### Uses of ProtocolMapperModel in org.keycloak.models.file.adapter

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

    Methods in org.keycloak.models.file.adapter that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<ProtocolMapperModel>` | ClientAdapter.`getProtocolMappers()`

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

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

    Methods in org.keycloak.models.jpa that return ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapperModel` | ClientAdapter.`addProtocolMapper(ProtocolMapperModel model)`
    `protected ProtocolMapperModel` | ClientAdapter.`entityToModel(ProtocolMapperEntity entity)`
    `ProtocolMapperModel` | ClientAdapter.`getProtocolMapperById(String id)`
    `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
    --- | ---
    `Set<ProtocolMapperModel>` | ClientAdapter.`getProtocolMappers()`

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

  - ### Uses of ProtocolMapperModel in org.keycloak.models.mongo.keycloak.adapters

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

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<ProtocolMapperModel>` | ClientAdapter.`getProtocolMappers()`

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

  - ### 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 types with arguments of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `List<ProtocolMapperModel>` | LoginProtocolFactory.`getBuiltinMappers()` List of built in protocol mappers that can be used to apply to clients.
    `List<ProtocolMapperModel>` | LoginProtocolFactory.`getDefaultBuiltinMappers()` List of mappers, which are added to new clients by default

  - ### 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
    --- | ---
    `List<ProtocolMapperModel>` | OIDCLoginProtocolFactory.`getBuiltinMappers()`
    `List<ProtocolMapperModel>` | OIDCLoginProtocolFactory.`getDefaultBuiltinMappers()`

  - ### 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 consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | HardcodedRole.`create(String name, String role)`
    `static ProtocolMapperModel` | RoleNameMapper.`create(String name, String role, String newName)`
    `static ProtocolMapperModel` | HardcodedClaim.`create(String name, String hardcodedName, String hardcodedValue, String claimType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | AddressMapper.`createAddressMapper()`
    `static ProtocolMapperModel` | AddressMapper.`createAddressMapper(boolean idToken, boolean accessToken)`
    `static ProtocolMapperModel` | UserAttributeMapper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserSessionNoteMapper.`createClaimMapper(String name, String userSessionNote, String tokenClaimName, String jsonType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | UserPropertyMapper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken)`
    `static ProtocolMapperModel` | OIDCAttributeMapperHelper.`createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean consentRequired, String consentText, boolean accessToken, boolean idToken, String mapperId)`

    Methods in org.keycloak.protocol.oidc.mappers with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | OIDCAttributeMapperHelper.`includeInAccessToken(ProtocolMapperModel mappingModel)`
    `static boolean` | OIDCAttributeMapperHelper.`includeInIDToken(ProtocolMapperModel mappingModel)`
    `static Object` | OIDCAttributeMapperHelper.`mapAttributeValue(ProtocolMapperModel mappingModel, Object attributeValue)`
    `static void` | OIDCAttributeMapperHelper.`mapClaim(IDToken token, ProtocolMapperModel mappingModel, Object attributeValue)`
    `protected void` | HardcodedClaim.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserAttributeMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserSessionNoteMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `protected void` | UserPropertyMapper.`setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession)`
    `AccessToken` | FullNameMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | AddressMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | RoleNameMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | HardcodedClaim.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | UserAttributeMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | HardcodedRole.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | UserSessionNoteMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | UserPropertyMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `AccessToken` | OIDCAccessTokenMapper.`transformAccessToken(AccessToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | FullNameMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | AddressMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | HardcodedClaim.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | UserAttributeMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | UserSessionNoteMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | OIDCIDTokenMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `IDToken` | UserPropertyMapper.`transformIDToken(IDToken token, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`

  - ### 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
    --- | ---
    `List<ProtocolMapperModel>` | SamlProtocolFactory.`getBuiltinMappers()`
    `List<ProtocolMapperModel>` | SamlProtocolFactory.`getDefaultBuiltinMappers()`

    Constructors in org.keycloak.protocol.saml with parameters of type ProtocolMapperModel
    Constructor and Description
    `SamlProtocol.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` | HardcodedAttributeMapper.`create(String name, String samlAttributeName, String nameFormat, String friendlyName, String value, boolean consentRequired, String consentText)`
    `static ProtocolMapperModel` | UserPropertyAttributeStatementMapper.`createAttributeMapper(String name, String userAttribute, String samlAttributeName, String nameFormat, String friendlyName, boolean consentRequired, String consentText)`
    `static ProtocolMapperModel` | UserAttributeStatementMapper.`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, boolean consentRequired, String consentText, String mapperId)`

    Methods in org.keycloak.protocol.saml.mappers with parameters of type ProtocolMapperModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | AttributeStatementHelper.`addAttribute(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, String attributeValue)`
    `static org.picketlink.identity.federation.saml.v2.assertion.AttributeType` | AttributeStatementHelper.`createAttributeType(ProtocolMapperModel mappingModel)`
    `String` | RoleNameMapper.`mapName(ProtocolMapperModel model, RoleModel roleModel)`
    `String` | SAMLRoleNameMapper.`mapName(ProtocolMapperModel model, RoleModel role)`
    `void` | SAMLRoleListMapper.`mapRoles(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | RoleListMapper.`mapRoles(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType roleAttributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | UserPropertyAttributeStatementMapper.`transformAttributeStatement(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | UserAttributeStatementMapper.`transformAttributeStatement(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | SAMLAttributeStatementMapper.`transformAttributeStatement(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `void` | HardcodedAttributeMapper.`transformAttributeStatement(org.picketlink.identity.federation.saml.v2.assertion.AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`
    `org.picketlink.identity.federation.saml.v2.protocol.ResponseType` | SAMLLoginResponseMapper.`transformLoginResponse(org.picketlink.identity.federation.saml.v2.protocol.ResponseType response, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, ClientSessionModel clientSession)`

Copyright © 2015. All rights reserved.