Package org.keycloak.protocol.oidc.mappers

Class GroupMembershipMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.protocol.oidc.mappers.GroupMembershipMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, UserInfoTokenMapper, org.keycloak.protocol.ProtocolMapper, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

public class GroupMembershipMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper

Maps user group membership

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
GroupMembershipMapper()

Method Summary

Modifier and Type	Method	Description
static org.keycloak.models.ProtocolMapperModel	create(String name, String tokenClaimName, boolean consentRequired, String consentText, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
List<org.keycloak.provider.ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
protected void	setClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, org.keycloak.models.UserSessionModel userSession)	Adds the group membership information to the JsonWebToken.otherClaims.
static boolean	useFullPath(org.keycloak.models.ProtocolMapperModel mappingModel)

Methods inherited from class org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

close, create, getEffectiveModel, getProtocol, getShouldUseLightweightToken, init, postInit, setClaim, setClaim, transformAccessToken, transformAccessTokenResponse, transformIDToken, transformIntrospectionToken, transformUserInfoToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper

transformAccessToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper

transformIDToken

Methods inherited from interface org.keycloak.protocol.ProtocolMapper

getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Methods inherited from interface org.keycloak.protocol.oidc.mappers.TokenIntrospectionTokenMapper

transformIntrospectionToken

Methods inherited from interface org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper

transformUserInfoToken

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

GroupMembershipMapper

public GroupMembershipMapper()

Method Details

getConfigProperties

public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface org.keycloak.provider.ProviderFactory<org.keycloak.protocol.ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface org.keycloak.protocol.ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface org.keycloak.protocol.ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface org.keycloak.provider.ConfiguredProvider

useFullPath

public static boolean useFullPath(org.keycloak.models.ProtocolMapperModel mappingModel)

setClaim

protected void setClaim(org.keycloak.representations.IDToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 org.keycloak.models.UserSessionModel userSession)

Adds the group membership information to the JsonWebToken.otherClaims.

Overrides:

setClaim in class AbstractOIDCProtocolMapper

Parameters:

token -

mappingModel -

userSession -

create

public static org.keycloak.models.ProtocolMapperModel create(String name,
 String tokenClaimName,
 boolean consentRequired,
 String consentText,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint)