Package org.keycloak.protocol.oidc.mappers

Class OIDCAttributeMapperHelper

java.lang.Object

org.keycloak.protocol.oidc.mappers.OIDCAttributeMapperHelper

public class OIDCAttributeMapperHelper
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_IN_ACCESS_TOKEN
static final String	INCLUDE_IN_ACCESS_TOKEN_HELP_TEXT
static final String	INCLUDE_IN_ACCESS_TOKEN_LABEL
static final String	INCLUDE_IN_ACCESS_TOKEN_RESPONSE
static final String	INCLUDE_IN_ACCESS_TOKEN_RESPONSE_HELP_TEXT
static final String	INCLUDE_IN_ACCESS_TOKEN_RESPONSE_LABEL
static final String	INCLUDE_IN_ID_TOKEN
static final String	INCLUDE_IN_ID_TOKEN_HELP_TEXT
static final String	INCLUDE_IN_ID_TOKEN_LABEL
static final String	INCLUDE_IN_INTROSPECTION
static final String	INCLUDE_IN_INTROSPECTION_HELP_TEXT
static final String	INCLUDE_IN_INTROSPECTION_LABEL
static final String	INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN
static final String	INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_HELP_TEXT
static final String	INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_LABEL
static final String	INCLUDE_IN_USERINFO
static final String	INCLUDE_IN_USERINFO_HELP_TEXT
static final String	INCLUDE_IN_USERINFO_LABEL
static final String	JSON_TYPE
static final String	JSON_TYPE_TOOLTIP
static final String	TOKEN_CLAIM_NAME
static final String	TOKEN_CLAIM_NAME_LABEL
static final String	TOKEN_CLAIM_NAME_TOOLTIP

Constructor Summary

Constructors

Constructor	Description
OIDCAttributeMapperHelper()

Method Summary

Modifier and Type	Method	Description
static void	addAttributeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties, Class<? extends org.keycloak.protocol.ProtocolMapper> protocolMapperClass)
static void	addIncludeInTokensConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties, Class<? extends org.keycloak.protocol.ProtocolMapper> protocolMapperClass)
static void	addJsonTypeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties)
static void	addJsonTypeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties, List<String> supportedTypes, String defaultValue)
static void	addTokenClaimNameConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties)
static org.keycloak.models.ProtocolMapperModel	createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean userinfo, boolean introspectionEndpoint, String mapperId)
static org.keycloak.models.ProtocolMapperModel	createClaimMapper(String name, String userAttribute, String tokenClaimName, String claimType, boolean accessToken, boolean idToken, boolean introspectionEndpoint, String mapperId)
static Map<String,Object>	getOrInitializeOrganizationClaimAsMap(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel effectiveModel)	Get or initialize the organization claim as a mutable Map for composition between organization mappers.
static boolean	includeInAccessToken(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	includeInAccessTokenResponse(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	includeInIDToken(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	includeInIntrospection(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	includeInLightweightAccessToken(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	includeInUserInfo(org.keycloak.models.ProtocolMapperModel mappingModel)
static boolean	isMultivalued(org.keycloak.models.ProtocolMapperModel mappingModel)
static Object	mapAttributeValue(org.keycloak.models.ProtocolMapperModel mappingModel, Object attributeValue)
static void	mapClaim(org.keycloak.representations.AccessTokenResponse token, org.keycloak.models.ProtocolMapperModel mappingModel, Object attributeValue)
static void	mapClaim(org.keycloak.representations.IDToken token, org.keycloak.models.ProtocolMapperModel mappingModel, Object attributeValue)

Methods inherited from class java.lang.Object

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

Field Details

TOKEN_CLAIM_NAME

public static final String TOKEN_CLAIM_NAME

See Also:

• Constant Field Values

TOKEN_CLAIM_NAME_LABEL

public static final String TOKEN_CLAIM_NAME_LABEL

See Also:

• Constant Field Values

TOKEN_CLAIM_NAME_TOOLTIP

public static final String TOKEN_CLAIM_NAME_TOOLTIP

See Also:

• Constant Field Values

JSON_TYPE

public static final String JSON_TYPE

See Also:

• Constant Field Values

JSON_TYPE_TOOLTIP

public static final String JSON_TYPE_TOOLTIP

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN

public static final String INCLUDE_IN_ACCESS_TOKEN

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN_LABEL

public static final String INCLUDE_IN_ACCESS_TOKEN_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN_HELP_TEXT

public static final String INCLUDE_IN_ACCESS_TOKEN_HELP_TEXT

See Also:

• Constant Field Values

INCLUDE_IN_ID_TOKEN

public static final String INCLUDE_IN_ID_TOKEN

See Also:

• Constant Field Values

INCLUDE_IN_ID_TOKEN_LABEL

public static final String INCLUDE_IN_ID_TOKEN_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_ID_TOKEN_HELP_TEXT

public static final String INCLUDE_IN_ID_TOKEN_HELP_TEXT

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN_RESPONSE

public static final String INCLUDE_IN_ACCESS_TOKEN_RESPONSE

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN_RESPONSE_LABEL

public static final String INCLUDE_IN_ACCESS_TOKEN_RESPONSE_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_ACCESS_TOKEN_RESPONSE_HELP_TEXT

public static final String INCLUDE_IN_ACCESS_TOKEN_RESPONSE_HELP_TEXT

See Also:

• Constant Field Values

INCLUDE_IN_USERINFO

public static final String INCLUDE_IN_USERINFO

See Also:

• Constant Field Values

INCLUDE_IN_USERINFO_LABEL

public static final String INCLUDE_IN_USERINFO_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_USERINFO_HELP_TEXT

public static final String INCLUDE_IN_USERINFO_HELP_TEXT

See Also:

• Constant Field Values

INCLUDE_IN_INTROSPECTION

public static final String INCLUDE_IN_INTROSPECTION

See Also:

• Constant Field Values

INCLUDE_IN_INTROSPECTION_LABEL

public static final String INCLUDE_IN_INTROSPECTION_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_INTROSPECTION_HELP_TEXT

public static final String INCLUDE_IN_INTROSPECTION_HELP_TEXT

See Also:

• Constant Field Values

INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN

public static final String INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN

See Also:

• Constant Field Values

INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_LABEL

public static final String INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_LABEL

See Also:

• Constant Field Values

INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_HELP_TEXT

public static final String INCLUDE_IN_LIGHTWEIGHT_ACCESS_TOKEN_HELP_TEXT

See Also:

• Constant Field Values

Constructor Details

OIDCAttributeMapperHelper

public OIDCAttributeMapperHelper()

Method Details

mapAttributeValue

public static Object mapAttributeValue(org.keycloak.models.ProtocolMapperModel mappingModel,
 Object attributeValue)

getOrInitializeOrganizationClaimAsMap

public static Map<String,Object> getOrInitializeOrganizationClaimAsMap(org.keycloak.representations.IDToken token,
 org.keycloak.models.ProtocolMapperModel effectiveModel)

Get or initialize the organization claim as a mutable Map for composition between organization mappers. Handles conversion from OrganizationMembershipMapper output to Map structure that OrganizationGroupMembershipMapper can add to. Supports ObjectNode (JSON type), Collection or String (String type), existing Map, or creates empty Map if null.

Parameters:

token - the token

effectiveModel - the effective model of the protocol mapper to retrieve the name of the organization claim

Returns:

a mutable Map that can be manipulated; changes will be reflected in the token

mapClaim

public static void mapClaim(org.keycloak.representations.IDToken token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 Object attributeValue)

mapClaim

public static void mapClaim(org.keycloak.representations.AccessTokenResponse token,
 org.keycloak.models.ProtocolMapperModel mappingModel,
 Object attributeValue)

createClaimMapper

public static org.keycloak.models.ProtocolMapperModel createClaimMapper(String name,
 String userAttribute,
 String tokenClaimName,
 String claimType,
 boolean accessToken,
 boolean idToken,
 boolean introspectionEndpoint,
 String mapperId)

createClaimMapper

public static org.keycloak.models.ProtocolMapperModel createClaimMapper(String name,
 String userAttribute,
 String tokenClaimName,
 String claimType,
 boolean accessToken,
 boolean idToken,
 boolean userinfo,
 boolean introspectionEndpoint,
 String mapperId)

includeInIDToken

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

includeInAccessToken

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

includeInAccessTokenResponse

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

isMultivalued

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

includeInUserInfo

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

includeInIntrospection

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

includeInLightweightAccessToken

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

addAttributeConfig

public static void addAttributeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties,
 Class<? extends org.keycloak.protocol.ProtocolMapper> protocolMapperClass)

addTokenClaimNameConfig

public static void addTokenClaimNameConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties)

addJsonTypeConfig

public static void addJsonTypeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties)

addJsonTypeConfig

public static void addJsonTypeConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties,
 List<String> supportedTypes,
 String defaultValue)

addIncludeInTokensConfig

public static void addIncludeInTokensConfig(List<org.keycloak.provider.ProviderConfigProperty> configProperties,
 Class<? extends org.keycloak.protocol.ProtocolMapper> protocolMapperClass)