Package org.keycloak.organization.protocol.mappers.saml

Class OrganizationMembershipMapper

java.lang.Object

org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper

org.keycloak.organization.protocol.mappers.saml.OrganizationMembershipMapper

All Implemented Interfaces:

ProtocolMapper, SAMLAttributeStatementMapper, ConfiguredProvider, EnvironmentDependentProviderFactory, Provider, ProviderFactory<ProtocolMapper>

public class OrganizationMembershipMapper
extends AbstractSAMLProtocolMapper
implements SAMLAttributeStatementMapper, EnvironmentDependentProviderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
static final String	ORGANIZATION_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
OrganizationMembershipMapper()

Method Summary

Modifier and Type	Method	Description
static ProtocolMapperModel	create()
List<ProviderConfigProperty>	getConfigProperties()
String	getDisplayCategory()
String	getDisplayType()
String	getHelpText()
String	getId()
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
void	transformAttributeStatement(AttributeStatementType attributeStatement, ProtocolMapperModel mappingModel, KeycloakSession session, UserSessionModel userSession, AuthenticatedClientSessionModel clientSession)

Methods inherited from class org.keycloak.protocol.saml.mappers.AbstractSAMLProtocolMapper

close, create, getProtocol, init, postInit

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.ProtocolMapper

getEffectiveModel, getPriority, validateConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

ORGANIZATION_ATTRIBUTE_NAME

public static final String ORGANIZATION_ATTRIBUTE_NAME

See Also:

• Constant Field Values

Constructor Details

OrganizationMembershipMapper

public OrganizationMembershipMapper()

Method Details

create

public static ProtocolMapperModel create()

transformAttributeStatement

public void transformAttributeStatement(AttributeStatementType attributeStatement,
 ProtocolMapperModel mappingModel,
 KeycloakSession session,
 UserSessionModel userSession,
 AuthenticatedClientSessionModel clientSession)

Specified by:

transformAttributeStatement in interface SAMLAttributeStatementMapper

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

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.