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 String	USER_METADATA_GROUP

Constructor Summary

Constructors

Constructor	Description
UserProfileUtil()

Method Summary

Modifier and Type	Method	Description
static boolean	addMetadataAttributeToUserProfile(String attrName, UserProfileMetadata metadata, AttributeGroupMetadata metadataGroup, Predicate<AttributeContext> userFederationUsersSelector, 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

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

addMetadataAttributeToUserProfile

public static boolean addMetadataAttributeToUserProfile(String attrName,
 UserProfileMetadata metadata,
 AttributeGroupMetadata metadataGroup,
 Predicate<AttributeContext> userFederationUsersSelector,
 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

userFederationUsersSelector - used to recognize if user belongs to this user-storage provider or not

guiOrder - guiOrder to where to put the attribute

storageProviderName - storageProviderName (just for logging purposes)

Returns:

true if attribute was added. False otherwise

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)