com.google.api.services.identitytoolkit.model

Class UserInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.identitytoolkit.model.UserInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class UserInfo
extends GenericJson

Template for an individual account info.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Identity Toolkit API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserInfo.ProviderUserInfo Model definition for UserInfoProviderUserInfo.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
UserInfo()

Method Summary

Modifier and Type	Method and Description
UserInfo	clone()
byte[]	decodePasswordHash() The user's hashed password.
byte[]	decodeSalt() The user's password salt.
UserInfo	encodePasswordHash(byte[] passwordHash) The user's hashed password.
UserInfo	encodeSalt(byte[] salt) The user's password salt.
Long	getCreatedAt() User creation timestamp.
String	getCustomAttributes() The custom attributes to be set in the user's id token.
Boolean	getCustomAuth() Whether the user is authenticated by the developer.
Boolean	getDisabled() Whether the user is disabled.
String	getDisplayName() The name of the user.
String	getEmail() The email of the user.
Boolean	getEmailVerified() Whether the email has been verified.
Long	getLastLoginAt() last login timestamp.
String	getLocalId() The local ID of the user.
String	getPasswordHash() The user's hashed password.
Double	getPasswordUpdatedAt() The timestamp when the password was last updated.
String	getPhoneNumber() User's phone number.
String	getPhotoUrl() The URL of the user profile photo.
List<UserInfo.ProviderUserInfo>	getProviderUserInfo() The IDP of the user.
String	getRawPassword() The user's plain text password.
String	getSalt() The user's password salt.
String	getScreenName() User's screen name at Twitter or login name at Github.
Long	getValidSince() Timestamp in seconds for valid login token.
Integer	getVersion() Version of the user's password.
UserInfo	set(String fieldName, Object value)
UserInfo	setCreatedAt(Long createdAt) User creation timestamp.
UserInfo	setCustomAttributes(String customAttributes) The custom attributes to be set in the user's id token.
UserInfo	setCustomAuth(Boolean customAuth) Whether the user is authenticated by the developer.
UserInfo	setDisabled(Boolean disabled) Whether the user is disabled.
UserInfo	setDisplayName(String displayName) The name of the user.
UserInfo	setEmail(String email) The email of the user.
UserInfo	setEmailVerified(Boolean emailVerified) Whether the email has been verified.
UserInfo	setLastLoginAt(Long lastLoginAt) last login timestamp.
UserInfo	setLocalId(String localId) The local ID of the user.
UserInfo	setPasswordHash(String passwordHash) The user's hashed password.
UserInfo	setPasswordUpdatedAt(Double passwordUpdatedAt) The timestamp when the password was last updated.
UserInfo	setPhoneNumber(String phoneNumber) User's phone number.
UserInfo	setPhotoUrl(String photoUrl) The URL of the user profile photo.
UserInfo	setProviderUserInfo(List<UserInfo.ProviderUserInfo> providerUserInfo) The IDP of the user.
UserInfo	setRawPassword(String rawPassword) The user's plain text password.
UserInfo	setSalt(String salt) The user's password salt.
UserInfo	setScreenName(String screenName) User's screen name at Twitter or login name at Github.
UserInfo	setValidSince(Long validSince) Timestamp in seconds for valid login token.
UserInfo	setVersion(Integer version) Version of the user's password.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

UserInfo

public UserInfo()

Method Detail

getCreatedAt

public Long getCreatedAt()

User creation timestamp.

Returns:

value or null for none

setCreatedAt

public UserInfo setCreatedAt(Long createdAt)

User creation timestamp.

Parameters:

createdAt - createdAt or null for none

getCustomAttributes

public String getCustomAttributes()

The custom attributes to be set in the user's id token.

Returns:

value or null for none

setCustomAttributes

public UserInfo setCustomAttributes(String customAttributes)

The custom attributes to be set in the user's id token.

Parameters:

customAttributes - customAttributes or null for none

getCustomAuth

public Boolean getCustomAuth()

Whether the user is authenticated by the developer.

Returns:

value or null for none

setCustomAuth

public UserInfo setCustomAuth(Boolean customAuth)

Whether the user is authenticated by the developer.

Parameters:

customAuth - customAuth or null for none

getDisabled

public Boolean getDisabled()

Whether the user is disabled.

Returns:

value or null for none

setDisabled

public UserInfo setDisabled(Boolean disabled)

Whether the user is disabled.

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

The name of the user.

Returns:

value or null for none

setDisplayName

public UserInfo setDisplayName(String displayName)

The name of the user.

Parameters:

displayName - displayName or null for none

getEmail

public String getEmail()

The email of the user.

Returns:

value or null for none

setEmail

public UserInfo setEmail(String email)

The email of the user.

Parameters:

email - email or null for none

getEmailVerified

public Boolean getEmailVerified()

Whether the email has been verified.

Returns:

value or null for none

setEmailVerified

public UserInfo setEmailVerified(Boolean emailVerified)

Whether the email has been verified.

Parameters:

emailVerified - emailVerified or null for none

getLastLoginAt

public Long getLastLoginAt()

last login timestamp.

Returns:

value or null for none

setLastLoginAt

public UserInfo setLastLoginAt(Long lastLoginAt)

last login timestamp.

Parameters:

lastLoginAt - lastLoginAt or null for none

getLocalId

public String getLocalId()

The local ID of the user.

Returns:

value or null for none

setLocalId

public UserInfo setLocalId(String localId)

The local ID of the user.

Parameters:

localId - localId or null for none

getPasswordHash

public String getPasswordHash()

The user's hashed password.

Returns:

value or null for none

See Also:

decodePasswordHash()

decodePasswordHash

public byte[] decodePasswordHash()

The user's hashed password.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPasswordHash()

setPasswordHash

public UserInfo setPasswordHash(String passwordHash)

The user's hashed password.

Parameters:

passwordHash - passwordHash or null for none

See Also:

#encodePasswordHash()

encodePasswordHash

public UserInfo encodePasswordHash(byte[] passwordHash)

The user's hashed password.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getPasswordUpdatedAt

public Double getPasswordUpdatedAt()

The timestamp when the password was last updated.

Returns:

value or null for none

setPasswordUpdatedAt

public UserInfo setPasswordUpdatedAt(Double passwordUpdatedAt)

The timestamp when the password was last updated.

Parameters:

passwordUpdatedAt - passwordUpdatedAt or null for none

getPhoneNumber

public String getPhoneNumber()

User's phone number.

Returns:

value or null for none

setPhoneNumber

public UserInfo setPhoneNumber(String phoneNumber)

User's phone number.

Parameters:

phoneNumber - phoneNumber or null for none

getPhotoUrl

public String getPhotoUrl()

The URL of the user profile photo.

Returns:

value or null for none

setPhotoUrl

public UserInfo setPhotoUrl(String photoUrl)

The URL of the user profile photo.

Parameters:

photoUrl - photoUrl or null for none

getProviderUserInfo

public List<UserInfo.ProviderUserInfo> getProviderUserInfo()

The IDP of the user.

Returns:

value or null for none

setProviderUserInfo

public UserInfo setProviderUserInfo(List<UserInfo.ProviderUserInfo> providerUserInfo)

The IDP of the user.

Parameters:

providerUserInfo - providerUserInfo or null for none

getRawPassword

public String getRawPassword()

The user's plain text password.

Returns:

value or null for none

setRawPassword

public UserInfo setRawPassword(String rawPassword)

The user's plain text password.

Parameters:

rawPassword - rawPassword or null for none

getSalt

public String getSalt()

The user's password salt.

Returns:

value or null for none

See Also:

decodeSalt()

decodeSalt

public byte[] decodeSalt()

The user's password salt.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getSalt()

setSalt

public UserInfo setSalt(String salt)

The user's password salt.

Parameters:

salt - salt or null for none

See Also:

#encodeSalt()

encodeSalt

public UserInfo encodeSalt(byte[] salt)

The user's password salt.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getScreenName

public String getScreenName()

User's screen name at Twitter or login name at Github.

Returns:

value or null for none

setScreenName

public UserInfo setScreenName(String screenName)

User's screen name at Twitter or login name at Github.

Parameters:

screenName - screenName or null for none

getValidSince

public Long getValidSince()

Timestamp in seconds for valid login token.

Returns:

value or null for none

setValidSince

public UserInfo setValidSince(Long validSince)

Timestamp in seconds for valid login token.

Parameters:

validSince - validSince or null for none

getVersion

public Integer getVersion()

Version of the user's password.

Returns:

value or null for none

setVersion

public UserInfo setVersion(Integer version)

Version of the user's password.

Parameters:

version - version or null for none

set

public UserInfo set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public UserInfo clone()

Overrides:

clone in class GenericJson