Package org.keycloak.representations.idm

Class UserRepresentation

java.lang.Object

org.keycloak.representations.idm.AbstractUserRepresentation

org.keycloak.representations.idm.UserRepresentation

Direct Known Subclasses:

AbstractResourceService.Permission, MemberRepresentation

public class UserRepresentation
extends AbstractUserRepresentation

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<String>>	applicationRoles	Deprecated.
protected List<UserConsentRepresentation>	clientConsents
protected Map<String,List<String>>	clientRoles
protected Long	createdTimestamp
protected List<CredentialRepresentation>	credentials
protected Set<String>	disableableCredentialTypes
protected Boolean	enabled
protected List<FederatedIdentityRepresentation>	federatedIdentities
protected String	federationLink
protected List<String>	groups
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

Fields inherited from class org.keycloak.representations.idm.AbstractUserRepresentation

attributes, email, EMAIL, emailVerified, FIRST_NAME, firstName, id, LAST_NAME, lastName, LOCALE, username, USERNAME

Constructor Summary

Constructors

Constructor	Description
UserRepresentation()
UserRepresentation(UserRepresentation rep)

Method Summary

Modifier and Type	Method	Description
Map<String,Boolean>	getAccess()
Map<String,List<String>>	getApplicationRoles()	Deprecated.
List<UserConsentRepresentation>	getClientConsents()
Map<String,List<String>>	getClientRoles()
Long	getCreatedTimestamp()
List<CredentialRepresentation>	getCredentials()
Set<String>	getDisableableCredentialTypes()
List<FederatedIdentityRepresentation>	getFederatedIdentities()
String	getFederationLink()
List<String>	getGroups()
Integer	getNotBefore()
String	getOrigin()	Deprecated. Use getFederationLink() instead
List<String>	getRealmRoles()
List<String>	getRequiredActions()
String	getSelf()
String	getServiceAccountClientId()
List<SocialLinkRepresentation>	getSocialLinks()
Boolean	isEnabled()
Boolean	isTotp()	Deprecated.
void	setAccess(Map<String,Boolean> access)
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	setEnabled(Boolean enabled)
void	setFederatedIdentities(List<FederatedIdentityRepresentation> federatedIdentities)
void	setFederationLink(String federationLink)
void	setGroups(List<String> groups)
void	setNotBefore(Integer notBefore)
void	setOrigin(String origin)	Deprecated. Use setFederationLink(String) instead
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.

Methods inherited from class org.keycloak.representations.idm.AbstractUserRepresentation

firstAttribute, getAttributes, getEmail, getFirstName, getId, getLastName, getRawAttributes, getUsername, getUserProfileMetadata, isEmailVerified, setAttributes, setEmail, setEmailVerified, setFirstName, setId, setLastName, setUsername, setUserProfileMetadata, singleAttribute

Methods inherited from class java.lang.Object

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

Field Details

self

protected String self

origin

protected String origin

createdTimestamp

protected Long createdTimestamp

enabled

protected Boolean enabled

totp

protected Boolean totp

federationLink

protected String federationLink

serviceAccountClientId

protected String serviceAccountClientId

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()

UserRepresentation

public UserRepresentation(UserRepresentation rep)

Method Details

getSelf

public String getSelf()

setSelf

public void setSelf(String self)

getCreatedTimestamp

public Long getCreatedTimestamp()

setCreatedTimestamp

public void setCreatedTimestamp(Long createdTimestamp)

isEnabled

public Boolean isEnabled()

setEnabled

public void setEnabled(Boolean enabled)

isTotp

@Deprecated
public Boolean isTotp()

Deprecated.

setTotp

@Deprecated
public void setTotp(Boolean totp)

Deprecated.

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

@Deprecated
public String getOrigin()

Deprecated.

Use getFederationLink() instead

Returns id of UserStorageProvider that loaded this user

Returns:

NULL if user stored locally

setOrigin

@Deprecated
public void setOrigin(String origin)

Deprecated.

Use setFederationLink(String) instead

Parameters:

origin - the 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)