Package org.keycloak.userprofile

Class UserProfileUtil

java.lang.Object

org.keycloak.userprofile.UserProfileUtil

public class UserProfileUtil
extends Object

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<AttributeContext>	ONLY_ADMIN_CONDITION
static final String	USER_METADATA_GROUP

Constructor Summary

Constructors

Constructor	Description
UserProfileUtil()

Method Summary

Modifier and Type	Method	Description
static AttributeMetadata	createAttributeMetadata(String attrName, UserProfileMetadata metadata, int guiOrder, String storageProviderName)
static AttributeMetadata	createAttributeMetadata(String attrName, UserProfileMetadata metadata, AttributeGroupMetadata metadataGroup, int guiOrder, String storageProviderName)	Adds metadata attribute to the user-profile for users from specified userStorageProvider
static UserProfileMetadata	createUserProfileMetadata(KeycloakSession session, UserProfile profile)
static boolean	isRootAttribute(String name)	Returns whether the attribute with the given name is a root attribute.
static AttributeGroupMetadata	lookupUserMetadataGroup(KeycloakSession session)	Find the metadata group "user-metadata"

Methods inherited from class java.lang.Object

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

Field Details

USER_METADATA_GROUP

public static final String USER_METADATA_GROUP

See Also:

• Constant Field Values

ONLY_ADMIN_CONDITION

public static final Predicate<AttributeContext> ONLY_ADMIN_CONDITION

Constructor Details

UserProfileUtil

public UserProfileUtil()

Method Details

lookupUserMetadataGroup

public static AttributeGroupMetadata lookupUserMetadataGroup(KeycloakSession session)

Find the metadata group "user-metadata"

Parameters:

session -

Returns:

metadata group if exists, otherwise null

createAttributeMetadata

public static AttributeMetadata createAttributeMetadata(String attrName,
 UserProfileMetadata metadata,
 AttributeGroupMetadata metadataGroup,
 int guiOrder,
 String storageProviderName)

Adds metadata attribute to the user-profile for users from specified userStorageProvider

Parameters:

attrName - attribute name

metadata - user-profile metadata where attribute would be added

metadataGroup - metadata group in user-profile

guiOrder - guiOrder to where to put the attribute

storageProviderName - storageProviderName (just for logging purposes)

Returns:

the attribute metadata if attribute was created. False otherwise

createAttributeMetadata

public static AttributeMetadata createAttributeMetadata(String attrName,
 UserProfileMetadata metadata,
 int guiOrder,
 String storageProviderName)

isRootAttribute

public static boolean isRootAttribute(String name)

Returns whether the attribute with the given name is a root attribute.

Parameters:

name - the attribute name

Returns:

createUserProfileMetadata

public static UserProfileMetadata createUserProfileMetadata(KeycloakSession session,
 UserProfile profile)