Package org.keycloak.representations.idm

Class UserRepresentation

java.lang.Object

org.keycloak.representations.idm.UserRepresentation

public class UserRepresentation
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<String>>	applicationRoles	Deprecated.
protected Map<String,List<String>>	attributes
protected List<UserConsentRepresentation>	clientConsents
protected Map<String,List<String>>	clientRoles
protected Long	createdTimestamp
protected List<CredentialRepresentation>	credentials
protected Set<String>	disableableCredentialTypes
protected String	email
protected Boolean	emailVerified
protected Boolean	enabled
protected List<FederatedIdentityRepresentation>	federatedIdentities
protected String	federationLink
protected String	firstName
protected List<String>	groups
protected String	id
protected String	lastName
protected Integer	notBefore
protected String	origin
protected List<String>	realmRoles
protected List<String>	requiredActions
protected String	self
protected String	serviceAccountClientId
protected List<SocialLinkRepresentation>	socialLinks	Deprecated.
protected Boolean	totp
protected String	username

Constructor Summary

Constructors

Constructor	Description
UserRepresentation()

Method Summary

Modifier and Type	Method	Description
String	firstAttribute(String key)
Map<String,Boolean>	getAccess()
Map<String,List<String>>	getApplicationRoles()	Deprecated.
Map<String,List<String>>	getAttributes()
List<UserConsentRepresentation>	getClientConsents()
Map<String,List<String>>	getClientRoles()
Long	getCreatedTimestamp()
List<CredentialRepresentation>	getCredentials()
Set<String>	getDisableableCredentialTypes()
String	getEmail()
List<FederatedIdentityRepresentation>	getFederatedIdentities()
String	getFederationLink()
String	getFirstName()
List<String>	getGroups()
String	getId()
String	getLastName()
Integer	getNotBefore()
String	getOrigin()	Returns id of UserStorageProvider that loaded this user
List<String>	getRealmRoles()
List<String>	getRequiredActions()
String	getSelf()
String	getServiceAccountClientId()
List<SocialLinkRepresentation>	getSocialLinks()
String	getUsername()
UserProfileMetadata	getUserProfileMetadata()
Boolean	isEmailVerified()
Boolean	isEnabled()
Boolean	isTotp()	Deprecated.
void	setAccess(Map<String,Boolean> access)
void	setAttributes(Map<String,List<String>> attributes)
void	setClientConsents(List<UserConsentRepresentation> clientConsents)
void	setClientRoles(Map<String,List<String>> clientRoles)
void	setCreatedTimestamp(Long createdTimestamp)
void	setCredentials(List<CredentialRepresentation> credentials)
void	setDisableableCredentialTypes(Set<String> disableableCredentialTypes)
void	setEmail(String email)
void	setEmailVerified(Boolean emailVerified)
void	setEnabled(Boolean enabled)
void	setFederatedIdentities(List<FederatedIdentityRepresentation> federatedIdentities)
void	setFederationLink(String federationLink)
void	setFirstName(String firstName)
void	setGroups(List<String> groups)
void	setId(String id)
void	setLastName(String lastName)
void	setNotBefore(Integer notBefore)
void	setOrigin(String origin)
void	setRealmRoles(List<String> realmRoles)
void	setRequiredActions(List<String> requiredActions)
void	setSelf(String self)
void	setServiceAccountClientId(String serviceAccountClientId)
void	setSocialLinks(List<SocialLinkRepresentation> socialLinks)
void	setTotp(Boolean totp)	Deprecated.
void	setUsername(String username)
void	setUserProfileMetadata(UserProfileMetadata userProfileMetadata)
UserRepresentation	singleAttribute(String name, String value)
Map<String,List<String>>	toAttributes()

Methods inherited from class java.lang.Object

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

Field Details

self

protected String self

id

protected String id

origin

protected String origin

createdTimestamp

protected Long createdTimestamp

username

protected String username

enabled

protected Boolean enabled

totp

protected Boolean totp

emailVerified

protected Boolean emailVerified

firstName

protected String firstName

lastName

protected String lastName

email

protected String email

federationLink

protected String federationLink

serviceAccountClientId

protected String serviceAccountClientId

attributes

protected Map<String,List<String>> attributes

credentials

protected List<CredentialRepresentation> credentials

disableableCredentialTypes

protected Set<String> disableableCredentialTypes

requiredActions

protected List<String> requiredActions

federatedIdentities

protected List<FederatedIdentityRepresentation> federatedIdentities

realmRoles

protected List<String> realmRoles

clientRoles

protected Map<String,List<String>> clientRoles

clientConsents

protected List<UserConsentRepresentation> clientConsents

notBefore

protected Integer notBefore

applicationRoles

@Deprecated
protected Map<String,List<String>> applicationRoles

Deprecated.

socialLinks

@Deprecated
protected List<SocialLinkRepresentation> socialLinks

Deprecated.

groups

protected List<String> groups

Constructor Details

UserRepresentation

public UserRepresentation()

Method Details

getSelf

public String getSelf()

setSelf

public void setSelf(String self)

getId

public String getId()

setId

public void setId(String id)

getCreatedTimestamp

public Long getCreatedTimestamp()

setCreatedTimestamp

public void setCreatedTimestamp(Long createdTimestamp)

getFirstName

public String getFirstName()

setFirstName

public void setFirstName(String firstName)

getLastName

public String getLastName()

setLastName

public void setLastName(String lastName)

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

isEnabled

public Boolean isEnabled()

setEnabled

public void setEnabled(Boolean enabled)

isTotp

@Deprecated
public Boolean isTotp()

Deprecated.

setTotp

@Deprecated
public void setTotp(Boolean totp)

Deprecated.

isEmailVerified

public Boolean isEmailVerified()

setEmailVerified

public void setEmailVerified(Boolean emailVerified)

getAttributes

public Map<String,List<String>> getAttributes()

setAttributes

public void setAttributes(Map<String,List<String>> attributes)

singleAttribute

public UserRepresentation singleAttribute(String name,
 String value)

firstAttribute

public String firstAttribute(String key)

getCredentials

public List<CredentialRepresentation> getCredentials()

setCredentials

public void setCredentials(List<CredentialRepresentation> credentials)

getRequiredActions

public List<String> getRequiredActions()

setRequiredActions

public void setRequiredActions(List<String> requiredActions)

getFederatedIdentities

public List<FederatedIdentityRepresentation> getFederatedIdentities()

setFederatedIdentities

public void setFederatedIdentities(List<FederatedIdentityRepresentation> federatedIdentities)

getSocialLinks

public List<SocialLinkRepresentation> getSocialLinks()

setSocialLinks

public void setSocialLinks(List<SocialLinkRepresentation> socialLinks)

getRealmRoles

public List<String> getRealmRoles()

setRealmRoles

public void setRealmRoles(List<String> realmRoles)

getClientRoles

public Map<String,List<String>> getClientRoles()

setClientRoles

public void setClientRoles(Map<String,List<String>> clientRoles)

getClientConsents

public List<UserConsentRepresentation> getClientConsents()

setClientConsents

public void setClientConsents(List<UserConsentRepresentation> clientConsents)

getNotBefore

public Integer getNotBefore()

setNotBefore

public void setNotBefore(Integer notBefore)

getApplicationRoles

@Deprecated
public Map<String,List<String>> getApplicationRoles()

Deprecated.

getFederationLink

public String getFederationLink()

setFederationLink

public void setFederationLink(String federationLink)

getServiceAccountClientId

public String getServiceAccountClientId()

setServiceAccountClientId

public void setServiceAccountClientId(String serviceAccountClientId)

getGroups

public List<String> getGroups()

setGroups

public void setGroups(List<String> groups)

getOrigin

public String getOrigin()

Returns id of UserStorageProvider that loaded this user

Returns:

NULL if user stored locally

setOrigin

public void setOrigin(String origin)

getDisableableCredentialTypes

public Set<String> getDisableableCredentialTypes()

setDisableableCredentialTypes

public void setDisableableCredentialTypes(Set<String> disableableCredentialTypes)

getAccess

public Map<String,Boolean> getAccess()

setAccess

public void setAccess(Map<String,Boolean> access)

toAttributes

public Map<String,List<String>> toAttributes()

setUserProfileMetadata

public void setUserProfileMetadata(UserProfileMetadata userProfileMetadata)

getUserProfileMetadata

public UserProfileMetadata getUserProfileMetadata()