UserInfo (OAuth 2.0 SDK with OpenID Connect extensions 5.8 API)

java.lang.Object
- com.nimbusds.openid.connect.sdk.claims.ClaimsSet
- - com.nimbusds.openid.connect.sdk.claims.UserInfo

public class UserInfo
extends ClaimsSet

UserInfo claims set, serialisable to a JSON object.

Example UserInfo claims set:

 {
   "sub"                : "248289761001",
   "name"               : "Jane Doe",
   "given_name"         : "Jane",
   "family_name"        : "Doe",
   "preferred_username" : "j.doe",
   "email"              : "[email protected]",
   "picture"            : "http://example.com/janedoe/me.jpg"
 }

Related specifications:

OpenID Connect Core 1.0, section 5.1.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDRESS_CLAIM_NAME` The address claim name.
`static String`	`BIRTHDATE_CLAIM_NAME` The birth date claim name.
`static String`	`EMAIL_CLAIM_NAME` The email claim name.
`static String`	`EMAIL_VERIFIED_CLAIM_NAME` The email verified claim name.
`static String`	`FAMILY_NAME_CLAIM_NAME` The family name claim name.
`static String`	`GENDER_CLAIM_NAME` The gender claim name.
`static String`	`GIVEN_NAME_CLAIM_NAME` The given name claim name.
`static String`	`LOCALE_CLAIM_NAME` The locale claim name.
`static String`	`MIDDLE_NAME_CLAIM_NAME` The middle name claim name.
`static String`	`NAME_CLAIM_NAME` The name claim name.
`static String`	`NICKNAME_CLAIM_NAME` The nickname claim name.
`static String`	`PHONE_NUMBER_CLAIM_NAME` The phone number claim name.
`static String`	`PHONE_NUMBER_VERIFIED_CLAIM_NAME` The phone number verified claim name.
`static String`	`PICTURE_CLAIM_NAME` The picture claim name.
`static String`	`PREFERRED_USERNAME_CLAIM_NAME` The preferred username claim name.
`static String`	`PROFILE_CLAIM_NAME` The profile claim name.
`static String`	`SUB_CLAIM_NAME` The subject claim name.
`static String`	`UPDATED_AT_CLAIM_NAME` The updated at claim name.
`static String`	`WEBSITE_CLAIM_NAME` The website claim name.
`static String`	`ZONEINFO_CLAIM_NAME` The zoneinfo claim name.

Constructor Summary

Constructors
Constructor and Description
`UserInfo(net.minidev.json.JSONObject jsonObject)` Creates a new UserInfo claims set from the specified JSON object.
`UserInfo(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)` Creates a new UserInfo claims set from the specified JSON Web Token (JWT) claims set.
`UserInfo(Subject sub)` Creates a new minimal UserInfo claims set.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`getAddress()` Gets the preferred address.
`Address`	`getAddress(com.nimbusds.langtag.LangTag langTag)` Gets the preferred address.
`Map<com.nimbusds.langtag.LangTag,Address>`	`getAddressEntries()` Gets the preferred address entries.
`String`	`getBirthdate()` Gets the date of birth.
`javax.mail.internet.InternetAddress`	`getEmail()` Gets the preferred email address.
`Boolean`	`getEmailVerified()` Gets the email verification status.
`String`	`getFamilyName()` Gets the surname or last name.
`String`	`getFamilyName(com.nimbusds.langtag.LangTag langTag)` Gets the surname or last name.
`Map<com.nimbusds.langtag.LangTag,String>`	`getFamilyNameEntries()` Gets the surname or last name entries.
`Gender`	`getGender()` Gets the gender.
`String`	`getGivenName()` Gets the given or first name.
`String`	`getGivenName(com.nimbusds.langtag.LangTag langTag)` Gets the given or first name.
`Map<com.nimbusds.langtag.LangTag,String>`	`getGivenNameEntries()` Gets the given or first name entries.
`String`	`getLocale()` Gets the locale.
`String`	`getMiddleName()` Gets the middle name.
`String`	`getMiddleName(com.nimbusds.langtag.LangTag langTag)` Gets the middle name.
`Map<com.nimbusds.langtag.LangTag,String>`	`getMiddleNameEntries()` Gets the middle name entries.
`String`	`getName()` Gets the full name.
`String`	`getName(com.nimbusds.langtag.LangTag langTag)` Gets the full name.
`Map<com.nimbusds.langtag.LangTag,String>`	`getNameEntries()` Gets the full name entries.
`String`	`getNickname()` Gets the casual name.
`String`	`getNickname(com.nimbusds.langtag.LangTag langTag)` Gets the casual name.
`Map<com.nimbusds.langtag.LangTag,String>`	`getNicknameEntries()` Gets the casual name entries.
`String`	`getPhoneNumber()` Gets the preferred telephone number.
`Boolean`	`getPhoneNumberVerified()` Gets the phone number verification status.
`URI`	`getPicture()` Gets the picture.
`String`	`getPreferredUsername()` Gets the preferred username.
`URI`	`getProfile()` Gets the profile page.
`static Set<String>`	`getStandardClaimNames()` Gets the names of the standard top-level UserInfo claims.
`Subject`	`getSubject()` Gets the UserInfo subject.
`Date`	`getUpdatedTime()` Gets the time the end-user information was last updated.
`URI`	`getWebsite()` Gets the web page or blog.
`String`	`getZoneinfo()` Gets the zoneinfo.
`static UserInfo`	`parse(String json)` Parses a UserInfo claims set from the specified JSON object string.
`void`	`putAll(UserInfo other)` Puts all claims from the specified other UserInfo claims set.
`void`	`setAddress(Address address)` Sets the preferred address.
`void`	`setAddress(Address address, com.nimbusds.langtag.LangTag langTag)` Sets the preferred address.
`void`	`setBirthdate(String birthdate)` Sets the date of birth.
`void`	`setEmail(javax.mail.internet.InternetAddress email)` Sets the preferred email address.
`void`	`setEmailVerified(Boolean emailVerified)` Sets the email verification status.
`void`	`setFamilyName(String familyName)` Sets the surname or last name.
`void`	`setFamilyName(String familyName, com.nimbusds.langtag.LangTag langTag)` Sets the surname or last name.
`void`	`setGender(Gender gender)` Sets the gender.
`void`	`setGivenName(String givenName)` Sets the given or first name.
`void`	`setGivenName(String givenName, com.nimbusds.langtag.LangTag langTag)` Sets the given or first name.
`void`	`setLocale(String locale)` Sets the locale.
`void`	`setMiddleName(String middleName)` Sets the middle name.
`void`	`setMiddleName(String middleName, com.nimbusds.langtag.LangTag langTag)` Sets the middle name.
`void`	`setName(String name)` Sets the full name.
`void`	`setName(String name, com.nimbusds.langtag.LangTag langTag)` Sets the full name.
`void`	`setNickname(String nickname)` Sets the casual name.
`void`	`setNickname(String nickname, com.nimbusds.langtag.LangTag langTag)` Sets the casual name.
`void`	`setPhoneNumber(String phoneNumber)` Sets the preferred telephone number.
`void`	`setPhoneNumberVerified(Boolean phoneNumberVerified)` Sets the email verification status.
`void`	`setPicture(URI picture)` Sets the picture.
`void`	`setPreferredUsername(String preferredUsername)` Sets the preferred username.
`void`	`setProfile(URI profile)` Sets the profile page.
`void`	`setUpdatedTime(Date updatedTime)` Sets the time the end-user information was last updated.
`void`	`setWebsite(URI website)` Sets the web page or blog.
`void`	`setZoneinfo(String zoneinfo)` Sets the zoneinfo.

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet
getBooleanClaim, getClaim, getClaim, getDateClaim, getEmailClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, putAll, putAll, setClaim, setClaim, setDateClaim, setEmailClaim, setURIClaim, setURLClaim, toJSONObject, toJWTClaimsSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUB_CLAIM_NAME
```
public static final String SUB_CLAIM_NAME
```
    The subject claim name.
    
    See Also:
    
    Constant Field Values
  - NAME_CLAIM_NAME
```
public static final String NAME_CLAIM_NAME
```
    The name claim name.
    
    See Also:
    
    Constant Field Values
  - GIVEN_NAME_CLAIM_NAME
```
public static final String GIVEN_NAME_CLAIM_NAME
```
    The given name claim name.
    
    See Also:
    
    Constant Field Values
  - FAMILY_NAME_CLAIM_NAME
```
public static final String FAMILY_NAME_CLAIM_NAME
```
    The family name claim name.
    
    See Also:
    
    Constant Field Values
  - MIDDLE_NAME_CLAIM_NAME
```
public static final String MIDDLE_NAME_CLAIM_NAME
```
    The middle name claim name.
    
    See Also:
    
    Constant Field Values
  - NICKNAME_CLAIM_NAME
```
public static final String NICKNAME_CLAIM_NAME
```
    The nickname claim name.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_USERNAME_CLAIM_NAME
```
public static final String PREFERRED_USERNAME_CLAIM_NAME
```
    The preferred username claim name.
    
    See Also:
    
    Constant Field Values
  - PROFILE_CLAIM_NAME
```
public static final String PROFILE_CLAIM_NAME
```
    The profile claim name.
    
    See Also:
    
    Constant Field Values
  - PICTURE_CLAIM_NAME
```
public static final String PICTURE_CLAIM_NAME
```
    The picture claim name.
    
    See Also:
    
    Constant Field Values
  - WEBSITE_CLAIM_NAME
```
public static final String WEBSITE_CLAIM_NAME
```
    The website claim name.
    
    See Also:
    
    Constant Field Values
  - EMAIL_CLAIM_NAME
```
public static final String EMAIL_CLAIM_NAME
```
    The email claim name.
    
    See Also:
    
    Constant Field Values
  - EMAIL_VERIFIED_CLAIM_NAME
```
public static final String EMAIL_VERIFIED_CLAIM_NAME
```
    The email verified claim name.
    
    See Also:
    
    Constant Field Values
  - GENDER_CLAIM_NAME
```
public static final String GENDER_CLAIM_NAME
```
    The gender claim name.
    
    See Also:
    
    Constant Field Values
  - BIRTHDATE_CLAIM_NAME
```
public static final String BIRTHDATE_CLAIM_NAME
```
    The birth date claim name.
    
    See Also:
    
    Constant Field Values
  - ZONEINFO_CLAIM_NAME
```
public static final String ZONEINFO_CLAIM_NAME
```
    The zoneinfo claim name.
    
    See Also:
    
    Constant Field Values
  - LOCALE_CLAIM_NAME
```
public static final String LOCALE_CLAIM_NAME
```
    The locale claim name.
    
    See Also:
    
    Constant Field Values
  - PHONE_NUMBER_CLAIM_NAME
```
public static final String PHONE_NUMBER_CLAIM_NAME
```
    The phone number claim name.
    
    See Also:
    
    Constant Field Values
  - PHONE_NUMBER_VERIFIED_CLAIM_NAME
```
public static final String PHONE_NUMBER_VERIFIED_CLAIM_NAME
```
    The phone number verified claim name.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_CLAIM_NAME
```
public static final String ADDRESS_CLAIM_NAME
```
    The address claim name.
    
    See Also:
    
    Constant Field Values
  - UPDATED_AT_CLAIM_NAME
```
public static final String UPDATED_AT_CLAIM_NAME
```
    The updated at claim name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserInfo
```
public UserInfo(Subject sub)
```
    Creates a new minimal UserInfo claims set.
    
    Parameters:
    
    sub - The subject. Must not be null.
  - UserInfo
```
public UserInfo(net.minidev.json.JSONObject jsonObject)
```
    Creates a new UserInfo claims set from the specified JSON object.
    
    Parameters:
    
    jsonObject - The JSON object. Must not be null.
    
    Throws:
    
    IllegalArgumentException - If the JSON object doesn't contain a subject sub string claim.
  - UserInfo
```
public UserInfo(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
```
    Creates a new UserInfo claims set from the specified JSON Web Token (JWT) claims set.
    
    Parameters:
    
    jwtClaimsSet - The JWT claims set. Must not be null.
    
    Throws:
    
    IllegalArgumentException - If the JWT claims set doesn't contain a subject sub string claim.
- Method Detail
  - getStandardClaimNames
```
public static Set<String> getStandardClaimNames()
```
    Gets the names of the standard top-level UserInfo claims.
    
    Returns:
    
    The names of the standard top-level UserInfo claims (read-only set).
  - putAll
```
public void putAll(UserInfo other)
```
    Puts all claims from the specified other UserInfo claims set.
    
    Parameters:
    
    other - The other UserInfo. Must have the same subject. Must not be null.
    
    Throws:
    
    IllegalArgumentException - If the other UserInfo claims set doesn't have an identical subject.
  - getSubject
```
public Subject getSubject()
```
    Gets the UserInfo subject. Corresponds to the sub claim.
    
    Returns:
    
    The subject.
  - getName
```
public String getName()
```
    Gets the full name. Corresponds to the name claim, with no language tag.
    
    Returns:
    
    The full name, null if not specified.
  - getName
```
public String getName(com.nimbusds.langtag.LangTag langTag)
```
    Gets the full name. Corresponds to the name claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The full name, null if not specified.
  - getNameEntries
```
public Map<com.nimbusds.langtag.LangTag,String> getNameEntries()
```
    Gets the full name entries. Correspond to the name claim.
    
    Returns:
    
    The full name entries, empty map if none.
  - setName
```
public void setName(String name)
```
    Sets the full name. Corresponds to the name claim, with no language tag.
    
    Parameters:
    
    name - The full name. If null the claim will be removed.
  - setName
```
public void setName(String name,
                    com.nimbusds.langtag.LangTag langTag)
```
    Sets the full name. Corresponds to the name claim, with an optional language tag.
    
    Parameters:
    
    name - The full name. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getGivenName
```
public String getGivenName()
```
    Gets the given or first name. Corresponds to the given_name claim, with no language tag.
    
    Returns:
    
    The given or first name, null if not specified.
  - getGivenName
```
public String getGivenName(com.nimbusds.langtag.LangTag langTag)
```
    Gets the given or first name. Corresponds to the given_name claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The given or first name, null if not specified.
  - getGivenNameEntries
```
public Map<com.nimbusds.langtag.LangTag,String> getGivenNameEntries()
```
    Gets the given or first name entries. Correspond to the given_name claim.
    
    Returns:
    
    The given or first name entries, empty map if none.
  - setGivenName
```
public void setGivenName(String givenName)
```
    Sets the given or first name. Corresponds to the given_name claim, with no language tag.
    
    Parameters:
    
    givenName - The given or first name. If null the claim will be removed.
  - setGivenName
```
public void setGivenName(String givenName,
                         com.nimbusds.langtag.LangTag langTag)
```
    Sets the given or first name. Corresponds to the given_name claim, with an optional language tag.
    
    Parameters:
    
    givenName - The given or first full name. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getFamilyName
```
public String getFamilyName()
```
    Gets the surname or last name. Corresponds to the family_name claim, with no language tag.
    
    Returns:
    
    The surname or last name, null if not specified.
  - getFamilyName
```
public String getFamilyName(com.nimbusds.langtag.LangTag langTag)
```
    Gets the surname or last name. Corresponds to the family_name claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The surname or last name, null if not specified.
  - getFamilyNameEntries
```
public Map<com.nimbusds.langtag.LangTag,String> getFamilyNameEntries()
```
    Gets the surname or last name entries. Correspond to the
    
    Returns:
    
    The surname or last name entries, empty map if none.
  - setFamilyName
```
public void setFamilyName(String familyName)
```
    Sets the surname or last name. Corresponds to the family_name claim, with no language tag.
    
    Parameters:
    
    familyName - The surname or last name. If null the claim will be removed.
  - setFamilyName
```
public void setFamilyName(String familyName,
                          com.nimbusds.langtag.LangTag langTag)
```
    Sets the surname or last name. Corresponds to the family_name claim, with an optional language tag.
    
    Parameters:
    
    familyName - The surname or last name. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getMiddleName
```
public String getMiddleName()
```
    Gets the middle name. Corresponds to the middle_name claim, with no language tag.
    
    Returns:
    
    The middle name, null if not specified.
  - getMiddleName
```
public String getMiddleName(com.nimbusds.langtag.LangTag langTag)
```
    Gets the middle name. Corresponds to the middle_name claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The middle name, null if not specified.
  - getMiddleNameEntries
```
public Map<com.nimbusds.langtag.LangTag,String> getMiddleNameEntries()
```
    Gets the middle name entries. Correspond to the middle_name claim.
    
    Returns:
    
    The middle name entries, empty map if none.
  - setMiddleName
```
public void setMiddleName(String middleName)
```
    Sets the middle name. Corresponds to the middle_name claim, with no language tag.
    
    Parameters:
    
    middleName - The middle name. If null the claim will be removed.
  - setMiddleName
```
public void setMiddleName(String middleName,
                          com.nimbusds.langtag.LangTag langTag)
```
    Sets the middle name. Corresponds to the middle_name claim, with an optional language tag.
    
    Parameters:
    
    middleName - The middle name. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getNickname
```
public String getNickname()
```
    Gets the casual name. Corresponds to the nickname claim, with no language tag.
    
    Returns:
    
    The casual name, null if not specified.
  - getNickname
```
public String getNickname(com.nimbusds.langtag.LangTag langTag)
```
    Gets the casual name. Corresponds to the nickname claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The casual name, null if not specified.
  - getNicknameEntries
```
public Map<com.nimbusds.langtag.LangTag,String> getNicknameEntries()
```
    Gets the casual name entries. Correspond to the nickname claim.
    
    Returns:
    
    The casual name entries, empty map if none.
  - setNickname
```
public void setNickname(String nickname)
```
    Sets the casual name. Corresponds to the nickname claim, with no language tag.
    
    Parameters:
    
    nickname - The casual name. If null the claim will be removed.
  - setNickname
```
public void setNickname(String nickname,
                        com.nimbusds.langtag.LangTag langTag)
```
    Sets the casual name. Corresponds to the nickname claim, with an optional language tag.
    
    Parameters:
    
    nickname - The casual name. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getPreferredUsername
```
public String getPreferredUsername()
```
    Gets the preferred username. Corresponds to the preferred_username claim.
    
    Returns:
    
    The preferred username, null if not specified.
  - setPreferredUsername
```
public void setPreferredUsername(String preferredUsername)
```
    Sets the preferred username. Corresponds to the preferred_username claim.
    
    Parameters:
    
    preferredUsername - The preferred username. If null the claim will be removed.
  - getProfile
```
public URI getProfile()
```
    Gets the profile page. Corresponds to the profile claim.
    
    Returns:
    
    The profile page URI, null if not specified.
  - setProfile
```
public void setProfile(URI profile)
```
    Sets the profile page. Corresponds to the profile claim.
    
    Parameters:
    
    profile - The profile page URI. If null the claim will be removed.
  - getPicture
```
public URI getPicture()
```
    Gets the picture. Corresponds to the picture claim.
    
    Returns:
    
    The picture URI, null if not specified.
  - setPicture
```
public void setPicture(URI picture)
```
    Sets the picture. Corresponds to the picture claim.
    
    Parameters:
    
    picture - The picture URI. If null the claim will be removed.
  - getWebsite
```
public URI getWebsite()
```
    Gets the web page or blog. Corresponds to the website claim.
    
    Returns:
    
    The web page or blog URI, null if not specified.
  - setWebsite
```
public void setWebsite(URI website)
```
    Sets the web page or blog. Corresponds to the website claim.
    
    Parameters:
    
    website - The web page or blog URI. If null the claim will be removed.
  - getEmail
```
public javax.mail.internet.InternetAddress getEmail()
```
    Gets the preferred email address. Corresponds to the email claim.
    
    Returns:
    
    The preferred email address, null if not specified.
  - setEmail
```
public void setEmail(javax.mail.internet.InternetAddress email)
```
    Sets the preferred email address. Corresponds to the email claim.
    
    Parameters:
    
    email - The preferred email address. If null the claim will be removed.
  - getEmailVerified
```
public Boolean getEmailVerified()
```
    Gets the email verification status. Corresponds to the email_verified claim.
    
    Returns:
    
    The email verification status, null if not specified.
  - setEmailVerified
```
public void setEmailVerified(Boolean emailVerified)
```
    Sets the email verification status. Corresponds to the email_verified claim.
    
    Parameters:
    
    emailVerified - The email verification status. If null the claim will be removed.
  - getGender
```
public Gender getGender()
```
    Gets the gender. Corresponds to the gender claim.
    
    Returns:
    
    The gender, null if not specified.
  - setGender
```
public void setGender(Gender gender)
```
    Sets the gender. Corresponds to the gender claim.
    
    Parameters:
    
    gender - The gender. If null the claim will be removed.
  - getBirthdate
```
public String getBirthdate()
```
    Gets the date of birth. Corresponds to the birthdate claim.
    
    Returns:
    
    The date of birth, null if not specified.
  - setBirthdate
```
public void setBirthdate(String birthdate)
```
    Sets the date of birth. Corresponds to the birthdate claim.
    
    Parameters:
    
    birthdate - The date of birth. If null the claim will be removed.
  - getZoneinfo
```
public String getZoneinfo()
```
    Gets the zoneinfo. Corresponds to the zoneinfo claim.
    
    Returns:
    
    The zoneinfo, null if not specified.
  - setZoneinfo
```
public void setZoneinfo(String zoneinfo)
```
    Sets the zoneinfo. Corresponds to the zoneinfo claim.
    
    Parameters:
    
    zoneinfo - The zoneinfo. If null the claim will be removed.
  - getLocale
```
public String getLocale()
```
    Gets the locale. Corresponds to the locale claim.
    
    Returns:
    
    The locale, null if not specified.
  - setLocale
```
public void setLocale(String locale)
```
    Sets the locale. Corresponds to the locale claim.
    
    Parameters:
    
    locale - The locale. If null the claim will be removed.
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Gets the preferred telephone number. Corresponds to the phone_number claim.
    
    Returns:
    
    The preferred telephone number, null if not specified.
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
    Sets the preferred telephone number. Corresponds to the phone_number claim.
    
    Parameters:
    
    phoneNumber - The preferred telephone number. If null the claim will be removed.
  - getPhoneNumberVerified
```
public Boolean getPhoneNumberVerified()
```
    Gets the phone number verification status. Corresponds to the phone_number_verified claim.
    
    Returns:
    
    The phone number verification status, null if not specified.
  - setPhoneNumberVerified
```
public void setPhoneNumberVerified(Boolean phoneNumberVerified)
```
    Sets the email verification status. Corresponds to the phone_number_verified claim.
    
    Parameters:
    
    phoneNumberVerified - The phone number verification status. If null the claim will be removed.
  - getAddress
```
public Address getAddress()
```
    Gets the preferred address. Corresponds to the address claim, with no language tag.
    
    Returns:
    
    The preferred address, null if not specified.
  - getAddress
```
public Address getAddress(com.nimbusds.langtag.LangTag langTag)
```
    Gets the preferred address. Corresponds to the address claim, with an optional language tag.
    
    Parameters:
    
    langTag - The language tag of the entry, null to get the non-tagged entry.
    
    Returns:
    
    The preferred address, null if not specified.
  - getAddressEntries
```
public Map<com.nimbusds.langtag.LangTag,Address> getAddressEntries()
```
    Gets the preferred address entries. Correspond to the address claim.
    
    Returns:
    
    The preferred address entries, empty map if none.
  - setAddress
```
public void setAddress(Address address)
```
    Sets the preferred address. Corresponds to the address claim, with no language tag.
    
    Parameters:
    
    address - The preferred address. If null the claim will be removed.
  - setAddress
```
public void setAddress(Address address,
                       com.nimbusds.langtag.LangTag langTag)
```
    Sets the preferred address. Corresponds to the address claim, with an optional language tag.
    
    Parameters:
    
    address - The preferred address. If null the claim will be removed.
    
    langTag - The language tag, null if not specified.
  - getUpdatedTime
```
public Date getUpdatedTime()
```
    Gets the time the end-user information was last updated. Corresponds to the updated_at claim.
    
    Returns:
    
    The time the end-user information was last updated, null if not specified.
  - setUpdatedTime
```
public void setUpdatedTime(Date updatedTime)
```
    Sets the time the end-user information was last updated. Corresponds to the updated_at claim.
    
    Parameters:
    
    updatedTime - The time the end-user information was last updated. If null the claim will be removed.
  - parse
```
public static UserInfo parse(String json)
                      throws ParseException
```
    Parses a UserInfo claims set from the specified JSON object string.
    
    Parameters:
    
    json - The JSON object string to parse. Must not be null.
    
    Returns:
    
    The UserInfo claims set.
    
    Throws:
    
    ParseException - If parsing failed.

Class UserInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

Methods inherited from class java.lang.Object

Field Detail

SUB_CLAIM_NAME

NAME_CLAIM_NAME

GIVEN_NAME_CLAIM_NAME

FAMILY_NAME_CLAIM_NAME

MIDDLE_NAME_CLAIM_NAME

NICKNAME_CLAIM_NAME

PREFERRED_USERNAME_CLAIM_NAME

PROFILE_CLAIM_NAME

PICTURE_CLAIM_NAME

WEBSITE_CLAIM_NAME

EMAIL_CLAIM_NAME

EMAIL_VERIFIED_CLAIM_NAME

GENDER_CLAIM_NAME

BIRTHDATE_CLAIM_NAME

ZONEINFO_CLAIM_NAME

LOCALE_CLAIM_NAME

PHONE_NUMBER_CLAIM_NAME

PHONE_NUMBER_VERIFIED_CLAIM_NAME

ADDRESS_CLAIM_NAME

UPDATED_AT_CLAIM_NAME

Constructor Detail

UserInfo

UserInfo

UserInfo

Method Detail

getStandardClaimNames

putAll

getSubject

getName

getName

getNameEntries

setName

setName

getGivenName

getGivenName

getGivenNameEntries

setGivenName

setGivenName

getFamilyName

getFamilyName

getFamilyNameEntries

setFamilyName

setFamilyName

getMiddleName

getMiddleName

getMiddleNameEntries

setMiddleName

setMiddleName

getNickname

getNickname

getNicknameEntries

setNickname

setNickname

getPreferredUsername

setPreferredUsername

getProfile

setProfile

getPicture

setPicture

getWebsite

setWebsite

getEmail

setEmail

getEmailVerified

setEmailVerified

getGender

setGender

getBirthdate

setBirthdate

getZoneinfo

setZoneinfo

getLocale

setLocale