Package org.keycloak.organization.protocol.mappers.oidc

Class OrganizationMembershipMapper

java.lang.Object

org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper

org.keycloak.organization.protocol.mappers.oidc.OrganizationMembershipMapper

All Implemented Interfaces:

OIDCAccessTokenMapper, OIDCIDTokenMapper, TokenIntrospectionTokenMapper, UserInfoTokenMapper, ProtocolMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class OrganizationMembershipMapper
extends AbstractOIDCProtocolMapper
implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ORGANIZATION_ATTRIBUTES
static final String	ADD_ORGANIZATION_ID
static final String	PROVIDER_ID

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

TOKEN_MAPPER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
OrganizationMembershipMapper()

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create(String name, boolean accessToken, boolean idToken, boolean introspectionEndpoint)
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
ProtocolMapperModel	getEffectiveModel(KeycloakSession session, RealmModel realm, ProtocolMapperModel model)
String	getHelpText()
String	getId()
boolean	isSupported(Config.Scope config)
protected void	setClaim(IDToken token, ProtocolMapperModel model, UserSessionModel userSession, KeycloakSession session, ClientSessionContext clientSessionCtx)	Intended to be overridden in ProtocolMapper implementations to add claims to an token.

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

close, create, 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

ADD_ORGANIZATION_ATTRIBUTES

public static final String ADD_ORGANIZATION_ATTRIBUTES

See Also:

• Constant Field Values

ADD_ORGANIZATION_ID

public static final String ADD_ORGANIZATION_ID

See Also:

• Constant Field Values

Constructor Details

OrganizationMembershipMapper

public OrganizationMembershipMapper()

Method Details

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

getId

public String getId()

Specified by:

getId in interface ProviderFactory<ProtocolMapper>

getDisplayType

public String getDisplayType()

Specified by:

getDisplayType in interface ProtocolMapper

getDisplayCategory

public String getDisplayCategory()

Specified by:

getDisplayCategory in interface ProtocolMapper

getHelpText

public String getHelpText()

Specified by:

getHelpText in interface ConfiguredProvider

setClaim

protected void setClaim(IDToken token,
 ProtocolMapperModel model,
 UserSessionModel userSession,
 KeycloakSession session,
 ClientSessionContext clientSessionCtx)

Description copied from class: AbstractOIDCProtocolMapper

Intended to be overridden in ProtocolMapper implementations to add claims to an token.

Overrides:

setClaim in class AbstractOIDCProtocolMapper

getEffectiveModel

public ProtocolMapperModel getEffectiveModel(KeycloakSession session,
 RealmModel realm,
 ProtocolMapperModel model)

Specified by:

getEffectiveModel in interface ProtocolMapper

Overrides:

getEffectiveModel in class AbstractOIDCProtocolMapper

create

public static ProtocolMapperModel create(String name,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint)

isSupported

public boolean isSupported(Config.Scope config)

Specified by:

isSupported in interface EnvironmentDependentProviderFactory