## Uses of Interface
org.keycloak.protocol.ProtocolMapper

- Packages that use ProtocolMapper
  Package | Description
  --- | ---
  org.keycloak.protocol |
  org.keycloak.protocol.docker.mapper |
  org.keycloak.protocol.oidc.mappers |
  org.keycloak.protocol.saml.mappers |

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

    Methods in org.keycloak.protocol that return types with arguments of type ProtocolMapper
    Modifier and Type | Method and Description
    --- | ---
    `static Stream<Map.Entry<ProtocolMapperModel,ProtocolMapper>>` | ProtocolMapperUtils.`getSortedProtocolMappers(KeycloakSession session, ClientSessionContext ctx)`

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

  - ### Uses of ProtocolMapper in org.keycloak.protocol.docker.mapper

    Classes in org.keycloak.protocol.docker.mapper that implement ProtocolMapper
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AllowAllDockerProtocolMapper` Populates token with requested scope.
    `class` | `DockerAuthV2ProtocolMapper`

    Methods in org.keycloak.protocol.docker.mapper that return ProtocolMapper
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolMapper` | DockerAuthV2ProtocolMapper.`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 and Description
    --- | ---
    `class` | `AbstractOIDCProtocolMapper`
    `class` | `AbstractPairwiseSubMapper` Set the 'sub' claim to pairwise .
    `class` | `AddressMapper`
    `class` | `AllowedWebOriginsProtocolMapper` Protocol mapper to add allowed web origins to the access token to the 'allowed-origins' claim
    `class` | `AudienceProtocolMapper`
    `class` | `AudienceResolveProtocolMapper` Protocol mapper, which adds all client_ids of "allowed" clients to the audience field of the token.
    `class` | `ClaimsParameterTokenMapper`
    `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` | `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` | `SHA256PairwiseSubMapper`
    `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 and Description
    --- | ---
    `ProtocolMapper` | AbstractOIDCProtocolMapper.`create(KeycloakSession session)`

    Method parameters in org.keycloak.protocol.oidc.mappers with type arguments of type ProtocolMapper
    Modifier and Type | Method and 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 and Description
    --- | ---
    `class` | `AbstractSAMLProtocolMapper`
    `class` | `HardcodedAttributeMapper` Mappings UserModel property (the property name of a getter method) to an AttributeStatement.
    `class` | `RoleListMapper`
    `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 and Description
    --- | ---
    `ProtocolMapper` | RoleNameMapper.`create(KeycloakSession session)`
    `ProtocolMapper` | AbstractSAMLProtocolMapper.`create(KeycloakSession session)`

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