Keycloak Core 24.0.0 · org.keycloak.representations.UserInfo

Modifier and Type	Field and Description
protected AddressClaimSet	address
protected String[]	audience
protected String	birthdate
protected String	claimsLocales
protected String	email
protected Boolean	emailVerified
protected String	familyName
protected String	gender
protected String	givenName
protected String	issuer
protected String	locale
protected String	middleName
protected String	name
protected String	nickName
protected Map<String, Object>	otherClaims
protected String	phoneNumber
protected Boolean	phoneNumberVerified
protected String	picture
protected String	preferredUsername
protected String	profile
protected String	sub
protected Long	updatedAt
protected String	website
protected String	zoneinfo

Access	Constructor and Description
public	UserInfo()

Method Summary

Modifier and Type	Method and Description
public AddressClaimSet	getAddress()
public String[]	getAudience()
public String	getBirthdate()
public String	getClaimsLocales()
public String	getEmail()
public Boolean	getEmailVerified()
public String	getFamilyName()
public String	getGender()
public String	getGivenName()
public String	getIssuer()
public String	getLocale()
public String	getMiddleName()
public String	getName()
public String	getNickName()
public Map<String, Object>	getOtherClaims() This is a map of any other claims and data that might be in the UserInfo.
public String	getPhoneNumber()
public Boolean	getPhoneNumberVerified()
public String	getPicture()
public String	getPreferredUsername()
public String	getProfile()
public String	getSub()
public String	getSubject()
public Long	getUpdatedAt()
public String	getWebsite()
public String	getZoneinfo()
public boolean	hasAudience(String audience)
public void	setAddress(AddressClaimSet address)
public void	setAudience(String... audience)
public void	setBirthdate(String birthdate)
public void	setClaimsLocales(String claimsLocales)
public void	setEmail(String email)
public void	setEmailVerified(Boolean emailVerified)
public void	setFamilyName(String familyName)
public void	setGender(String gender)
public void	setGivenName(String givenName)
public void	setIssuer(String issuer)
public void	setLocale(String locale)
public void	setMiddleName(String middleName)
public void	setName(String name)
public void	setNickName(String nickName)
public void	setOtherClaims(String name, Object value)
public void	setPhoneNumber(String phoneNumber)
public void	setPhoneNumberVerified(Boolean phoneNumberVerified)
public void	setPicture(String picture)
public void	setPreferredUsername(String preferredUsername)
public void	setProfile(String profile)
public void	setSub(String sub)
public void	setSubject(String subject)
public void	setUpdatedAt(Long updatedAt)
public void	setWebsite(String website)
public void	setZoneinfo(String zoneinfo)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

address	back to summary
protected AddressClaimSet address Annotations @JsonProperty:address

audience	back to summary
protected String[] audience Annotations @JsonProperty:aud @JsonSerialize using:StringOrArraySerializer @JsonDeserialize using:StringOrArrayDeserializer

birthdate	back to summary
protected String birthdate Annotations @JsonProperty:birthdate

claimsLocales	back to summary
protected String claimsLocales Annotations @JsonProperty:claims_locales

email	back to summary
protected String email Annotations @JsonProperty:email

emailVerified	back to summary
protected Boolean emailVerified Annotations @JsonProperty:email_verified

familyName	back to summary
protected String familyName Annotations @JsonProperty:family_name

gender	back to summary
protected String gender Annotations @JsonProperty:gender

givenName	back to summary
protected String givenName Annotations @JsonProperty:given_name

issuer	back to summary
protected String issuer Annotations @JsonProperty:iss

locale	back to summary
protected String locale Annotations @JsonProperty:locale

middleName	back to summary
protected String middleName Annotations @JsonProperty:middle_name

name	back to summary
protected String name Annotations @JsonProperty:name

nickName	back to summary
protected String nickName Annotations @JsonProperty:nickname

otherClaims	back to summary
protected Map<String, Object> otherClaims

phoneNumber	back to summary
protected String phoneNumber Annotations @JsonProperty:phone_number

phoneNumberVerified	back to summary
protected Boolean phoneNumberVerified Annotations @JsonProperty:phone_number_verified

picture	back to summary
protected String picture Annotations @JsonProperty:picture

preferredUsername	back to summary
protected String preferredUsername Annotations @JsonProperty:preferred_username

profile	back to summary
protected String profile Annotations @JsonProperty:profile

sub	back to summary
protected String sub Annotations @JsonProperty:sub

updatedAt	back to summary
protected Long updatedAt Annotations @JsonProperty:updated_at

website	back to summary
protected String website Annotations @JsonProperty:website

zoneinfo	back to summary
protected String zoneinfo Annotations @JsonProperty:zoneinfo

Constructor Detail

UserInfo	back to summary
public UserInfo()

Method Detail

getAddress	back to summary
public AddressClaimSet getAddress()

getAudience	back to summary
public String[] getAudience() Annotations @JsonIgnore

getBirthdate	back to summary
public String getBirthdate()

getClaimsLocales	back to summary
public String getClaimsLocales()

getEmail	back to summary
public String getEmail()

getEmailVerified	back to summary
public Boolean getEmailVerified()

getFamilyName	back to summary
public String getFamilyName()

getGender	back to summary
public String getGender()

getGivenName	back to summary
public String getGivenName()

getIssuer	back to summary
public String getIssuer()

getLocale	back to summary
public String getLocale()

getMiddleName	back to summary
public String getMiddleName()

getName	back to summary
public String getName()

getNickName	back to summary
public String getNickName()

getOtherClaims	back to summary
public Map<String, Object> getOtherClaims() This is a map of any other claims and data that might be in the UserInfo. Could be custom claims set up by the auth server Annotations @JsonAnyGetter

getOtherClaims

back to summary

public Map<String, Object> getOtherClaims()

This is a map of any other claims and data that might be in the UserInfo. Could be custom claims set up by the auth server

Annotations

@JsonAnyGetter

getPhoneNumber	back to summary
public String getPhoneNumber()

getPhoneNumberVerified	back to summary
public Boolean getPhoneNumberVerified()

getPicture	back to summary
public String getPicture()

getPreferredUsername	back to summary
public String getPreferredUsername()

getProfile	back to summary
public String getProfile()

getSub	back to summary
public String getSub()

getSubject	back to summary
public String getSubject()

getUpdatedAt	back to summary
public Long getUpdatedAt()

getWebsite	back to summary
public String getWebsite()

getZoneinfo	back to summary
public String getZoneinfo()

hasAudience	back to summary
public boolean hasAudience(String audience)

setAddress	back to summary
public void setAddress(AddressClaimSet address)

setAudience	back to summary
public void setAudience(String... audience)

setBirthdate	back to summary
public void setBirthdate(String birthdate)

setClaimsLocales	back to summary
public void setClaimsLocales(String claimsLocales)

setEmail	back to summary
public void setEmail(String email)

setEmailVerified	back to summary
public void setEmailVerified(Boolean emailVerified)

setFamilyName	back to summary
public void setFamilyName(String familyName)

setGender	back to summary
public void setGender(String gender)

setGivenName	back to summary
public void setGivenName(String givenName)

setIssuer	back to summary
public void setIssuer(String issuer)

setLocale	back to summary
public void setLocale(String locale)

setMiddleName	back to summary
public void setMiddleName(String middleName)

setName	back to summary
public void setName(String name)

setNickName	back to summary
public void setNickName(String nickName)

setOtherClaims	back to summary
public void setOtherClaims(String name, Object value) Annotations @JsonAnySetter

setPhoneNumber	back to summary
public void setPhoneNumber(String phoneNumber)

setPhoneNumberVerified	back to summary
public void setPhoneNumberVerified(Boolean phoneNumberVerified)

setPicture	back to summary
public void setPicture(String picture)

setPreferredUsername	back to summary
public void setPreferredUsername(String preferredUsername)

setProfile	back to summary
public void setProfile(String profile)

setSub	back to summary
public void setSub(String sub)

setSubject	back to summary
public void setSubject(String subject)

setUpdatedAt	back to summary
public void setUpdatedAt(Long updatedAt)

setWebsite	back to summary
public void setWebsite(String website)

setZoneinfo	back to summary
public void setZoneinfo(String zoneinfo)

public Class UserInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail