• Home
• com.google.apis
• google-api-services-admin-directory
• directory_v1-rev20220802-2.0.0
• source code
• User.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.directory.model.User.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.directory.model
Class User



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.directory.model.User













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class User
extends GenericJson
The Directory API allows you to create and manage your account's users, user aliases, and user
 Gmail chat profile photos. For more information about common tasks, see the [User Accounts
 Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases
 Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).

 
 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 Admin SDK 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/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


User() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


User
clone() 


Object
getAddresses()
A list of the user's addresses.



Boolean
getAgreedToTerms()
Output only.



List<String>
getAliases()
Output only.



Boolean
getArchived()
Indicates if user is archived.



Boolean
getChangePasswordAtNextLogin()
Indicates if the user is forced to change their password at next login.



DateTime
getCreationTime()
User's G Suite account creation time.



String
getCustomerId()
Output only.



Map<String,Map<String,Object>>
getCustomSchemas()
Custom fields of the user.



DateTime
getDeletionTime() 


Object
getEmails()
A list of the user's email addresses.



String
getEtag()
Output only.



Object
getExternalIds()
A list of external IDs for the user, such as an employee or network ID.



Object
getGender()
The user's gender.



String
getHashFunction()
Stores the hash format of the `password` property.



String
getId()
The unique ID for the user.



Object
getIms()
The user's Instant Messenger (IM) accounts.



Boolean
getIncludeInGlobalAddressList()
Indicates if the user's profile is visible in the Google Workspace global address list when the
 contact sharing feature is enabled for the domain.



Boolean
getIpWhitelisted()
If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).



Boolean
getIsAdmin()
Output only.



Boolean
getIsDelegatedAdmin()
Output only.



Boolean
getIsEnforcedIn2Sv()
Output only.



Boolean
getIsEnrolledIn2Sv()
Output only.



Boolean
getIsMailboxSetup()
Output only.



Object
getKeywords()
The user's keywords.



String
getKind()
Output only.



Object
getLanguages()
The user's languages.



DateTime
getLastLoginTime()
User's last login time.



Object
getLocations()
The user's locations.



UserName
getName()
Holds the given and family names of the user, and the read-only `fullName` value.



List<String>
getNonEditableAliases()
Output only.



Object
getNotes()
Notes for the user.



Object
getOrganizations()
A list of organizations the user belongs to.



String
getOrgUnitPath()
The full path of the parent organization associated with the user.



String
getPassword()
User's password



Object
getPhones()
A list of the user's phone numbers.



Object
getPosixAccounts()
A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
 for the user.



String
getPrimaryEmail()
The user's primary email address.



String
getRecoveryEmail()
Recovery email of the user.



String
getRecoveryPhone()
Recovery phone of the user.



Object
getRelations()
A list of the user's relationships to other users.



Object
getSshPublicKeys()
A list of SSH public keys.



Boolean
getSuspended()
Indicates if user is suspended.



String
getSuspensionReason()
Output only.



String
getThumbnailPhotoEtag()
Output only.



String
getThumbnailPhotoUrl()
Output only.



Object
getWebsites()
The user's websites.



User
set(String fieldName,
   Object value) 


User
setAddresses(Object addresses)
A list of the user's addresses.



User
setAgreedToTerms(Boolean agreedToTerms)
Output only.



User
setAliases(List<String> aliases)
Output only.



User
setArchived(Boolean archived)
Indicates if user is archived.



User
setChangePasswordAtNextLogin(Boolean changePasswordAtNextLogin)
Indicates if the user is forced to change their password at next login.



User
setCreationTime(DateTime creationTime)
User's G Suite account creation time.



User
setCustomerId(String customerId)
Output only.



User
setCustomSchemas(Map<String,Map<String,Object>> customSchemas)
Custom fields of the user.



User
setDeletionTime(DateTime deletionTime) 


User
setEmails(Object emails)
A list of the user's email addresses.



User
setEtag(String etag)
Output only.



User
setExternalIds(Object externalIds)
A list of external IDs for the user, such as an employee or network ID.



User
setGender(Object gender)
The user's gender.



User
setHashFunction(String hashFunction)
Stores the hash format of the `password` property.



User
setId(String id)
The unique ID for the user.



User
setIms(Object ims)
The user's Instant Messenger (IM) accounts.



User
setIncludeInGlobalAddressList(Boolean includeInGlobalAddressList)
Indicates if the user's profile is visible in the Google Workspace global address list when the
 contact sharing feature is enabled for the domain.



User
setIpWhitelisted(Boolean ipWhitelisted)
If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).



User
setIsAdmin(Boolean isAdmin)
Output only.



User
setIsDelegatedAdmin(Boolean isDelegatedAdmin)
Output only.



User
setIsEnforcedIn2Sv(Boolean isEnforcedIn2Sv)
Output only.



User
setIsEnrolledIn2Sv(Boolean isEnrolledIn2Sv)
Output only.



User
setIsMailboxSetup(Boolean isMailboxSetup)
Output only.



User
setKeywords(Object keywords)
The user's keywords.



User
setKind(String kind)
Output only.



User
setLanguages(Object languages)
The user's languages.



User
setLastLoginTime(DateTime lastLoginTime)
User's last login time.



User
setLocations(Object locations)
The user's locations.



User
setName(UserName name)
Holds the given and family names of the user, and the read-only `fullName` value.



User
setNonEditableAliases(List<String> nonEditableAliases)
Output only.



User
setNotes(Object notes)
Notes for the user.



User
setOrganizations(Object organizations)
A list of organizations the user belongs to.



User
setOrgUnitPath(String orgUnitPath)
The full path of the parent organization associated with the user.



User
setPassword(String password)
User's password



User
setPhones(Object phones)
A list of the user's phone numbers.



User
setPosixAccounts(Object posixAccounts)
A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
 for the user.



User
setPrimaryEmail(String primaryEmail)
The user's primary email address.



User
setRecoveryEmail(String recoveryEmail)
Recovery email of the user.



User
setRecoveryPhone(String recoveryPhone)
Recovery phone of the user.



User
setRelations(Object relations)
A list of the user's relationships to other users.



User
setSshPublicKeys(Object sshPublicKeys)
A list of SSH public keys.



User
setSuspended(Boolean suspended)
Indicates if user is suspended.



User
setSuspensionReason(String suspensionReason)
Output only.



User
setThumbnailPhotoEtag(String thumbnailPhotoEtag)
Output only.



User
setThumbnailPhotoUrl(String thumbnailPhotoUrl)
Output only.



User
setWebsites(Object websites)
The user's websites.







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





User
public User()









Method Detail





getAddresses
public Object getAddresses()
A list of the user's addresses. The maximum allowed data size for this field is 10Kb.

Returns:
value or null for none








setAddresses
public User setAddresses(Object addresses)
A list of the user's addresses. The maximum allowed data size for this field is 10Kb.

Parameters:
addresses - addresses or null for none








getAgreedToTerms
public Boolean getAgreedToTerms()
Output only. This property is `true` if the user has completed an initial login and accepted
 the Terms of Service agreement.

Returns:
value or null for none








setAgreedToTerms
public User setAgreedToTerms(Boolean agreedToTerms)
Output only. This property is `true` if the user has completed an initial login and accepted
 the Terms of Service agreement.

Parameters:
agreedToTerms - agreedToTerms or null for none








getAliases
public List<String> getAliases()
Output only. A list of the user's alias email addresses.

Returns:
value or null for none








setAliases
public User setAliases(List<String> aliases)
Output only. A list of the user's alias email addresses.

Parameters:
aliases - aliases or null for none








getArchived
public Boolean getArchived()
Indicates if user is archived.

Returns:
value or null for none








setArchived
public User setArchived(Boolean archived)
Indicates if user is archived.

Parameters:
archived - archived or null for none








getChangePasswordAtNextLogin
public Boolean getChangePasswordAtNextLogin()
Indicates if the user is forced to change their password at next login. This setting doesn't
 apply when [the user signs in via a third-party identity
 provider](https://support.google.com/a/answer/60224).

Returns:
value or null for none








setChangePasswordAtNextLogin
public User setChangePasswordAtNextLogin(Boolean changePasswordAtNextLogin)
Indicates if the user is forced to change their password at next login. This setting doesn't
 apply when [the user signs in via a third-party identity
 provider](https://support.google.com/a/answer/60224).

Parameters:
changePasswordAtNextLogin - changePasswordAtNextLogin or null for none








getCreationTime
public DateTime getCreationTime()
User's G Suite account creation time. (Read-only)

Returns:
value or null for none








setCreationTime
public User setCreationTime(DateTime creationTime)
User's G Suite account creation time. (Read-only)

Parameters:
creationTime - creationTime or null for none








getCustomSchemas
public Map<String,Map<String,Object>> getCustomSchemas()
Custom fields of the user. The key is a `schema_name` and its values are `'field_name':
 'field_value'`.

Returns:
value or null for none








setCustomSchemas
public User setCustomSchemas(Map<String,Map<String,Object>> customSchemas)
Custom fields of the user. The key is a `schema_name` and its values are `'field_name':
 'field_value'`.

Parameters:
customSchemas - customSchemas or null for none








getCustomerId
public String getCustomerId()
Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides
 /manage-users.html#get_all_users). You can use the alias `my_customer` to represent your
 account's `customerId`. As a reseller administrator, you can use the resold customer account's
 `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter
 of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.

Returns:
value or null for none








setCustomerId
public User setCustomerId(String customerId)
Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides
 /manage-users.html#get_all_users). You can use the alias `my_customer` to represent your
 account's `customerId`. As a reseller administrator, you can use the resold customer account's
 `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter
 of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.

Parameters:
customerId - customerId or null for none








getDeletionTime
public DateTime getDeletionTime()

Returns:
value or null for none








setDeletionTime
public User setDeletionTime(DateTime deletionTime)

Parameters:
deletionTime - deletionTime or null for none








getEmails
public Object getEmails()
A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.

Returns:
value or null for none








setEmails
public User setEmails(Object emails)
A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.

Parameters:
emails - emails or null for none








getEtag
public String getEtag()
Output only. ETag of the resource.

Returns:
value or null for none








setEtag
public User setEtag(String etag)
Output only. ETag of the resource.

Parameters:
etag - etag or null for none








getExternalIds
public Object getExternalIds()
A list of external IDs for the user, such as an employee or network ID. The maximum allowed
 data size for this field is 2Kb.

Returns:
value or null for none








setExternalIds
public User setExternalIds(Object externalIds)
A list of external IDs for the user, such as an employee or network ID. The maximum allowed
 data size for this field is 2Kb.

Parameters:
externalIds - externalIds or null for none








getGender
public Object getGender()
The user's gender. The maximum allowed data size for this field is 1Kb.

Returns:
value or null for none








setGender
public User setGender(Object gender)
The user's gender. The maximum allowed data size for this field is 1Kb.

Parameters:
gender - gender or null for none








getHashFunction
public String getHashFunction()
Stores the hash format of the `password` property. The following `hashFunction` values are
 allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA1` - Accepts simple hex-encoded
 values. * `crypt` - Compliant with the [C crypt
 library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix
 `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds
 are specified as part of the prefix, they must be 10,000 or fewer.

Returns:
value or null for none








setHashFunction
public User setHashFunction(String hashFunction)
Stores the hash format of the `password` property. The following `hashFunction` values are
 allowed: * `MD5` - Accepts simple hex-encoded values. * `SHA1` - Accepts simple hex-encoded
 values. * `crypt` - Compliant with the [C crypt
 library](https://en.wikipedia.org/wiki/Crypt_%28C%29). Supports the DES, MD5 (hash prefix
 `$1$`), SHA-256 (hash prefix `$5$`), and SHA-512 (hash prefix `$6$`) hash algorithms. If rounds
 are specified as part of the prefix, they must be 10,000 or fewer.

Parameters:
hashFunction - hashFunction or null for none








getId
public String getId()
The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.

Returns:
value or null for none








setId
public User setId(String id)
The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.

Parameters:
id - id or null for none








getIms
public Object getIms()
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties.
 But, only one of these ims properties can be the primary IM contact. The maximum allowed data
 size for this field is 2Kb.

Returns:
value or null for none








setIms
public User setIms(Object ims)
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties.
 But, only one of these ims properties can be the primary IM contact. The maximum allowed data
 size for this field is 2Kb.

Parameters:
ims - ims or null for none








getIncludeInGlobalAddressList
public Boolean getIncludeInGlobalAddressList()
Indicates if the user's profile is visible in the Google Workspace global address list when the
 contact sharing feature is enabled for the domain. For more information about excluding user
 profiles, see the [administration help center](https://support.google.com/a/answer/1285988).

Returns:
value or null for none








setIncludeInGlobalAddressList
public User setIncludeInGlobalAddressList(Boolean includeInGlobalAddressList)
Indicates if the user's profile is visible in the Google Workspace global address list when the
 contact sharing feature is enabled for the domain. For more information about excluding user
 profiles, see the [administration help center](https://support.google.com/a/answer/1285988).

Parameters:
includeInGlobalAddressList - includeInGlobalAddressList or null for none








getIpWhitelisted
public Boolean getIpWhitelisted()
If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).

Returns:
value or null for none








setIpWhitelisted
public User setIpWhitelisted(Boolean ipWhitelisted)
If `true`, the user's IP address is [whitelisted](https://support.google.com/a/answer/60752).

Parameters:
ipWhitelisted - ipWhitelisted or null for none








getIsAdmin
public Boolean getIsAdmin()
Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can
 only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-
 users.html#make_admin) operation ( [makeAdmin](/admin-
 sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert
 ](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-
 sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.

Returns:
value or null for none








setIsAdmin
public User setIsAdmin(Boolean isAdmin)
Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can
 only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-
 users.html#make_admin) operation ( [makeAdmin](/admin-
 sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert
 ](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-
 sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.

Parameters:
isAdmin - isAdmin or null for none








getIsDelegatedAdmin
public Boolean getIsDelegatedAdmin()
Output only. Indicates if the user is a delegated administrator. Delegated administrators are
 supported by the API but cannot create or undelete users, or make users administrators. These
 requests are ignored by the API service. Roles and privileges for administrators are assigned
 using the [Admin console](https://support.google.com/a/answer/33325).

Returns:
value or null for none








setIsDelegatedAdmin
public User setIsDelegatedAdmin(Boolean isDelegatedAdmin)
Output only. Indicates if the user is a delegated administrator. Delegated administrators are
 supported by the API but cannot create or undelete users, or make users administrators. These
 requests are ignored by the API service. Roles and privileges for administrators are assigned
 using the [Admin console](https://support.google.com/a/answer/33325).

Parameters:
isDelegatedAdmin - isDelegatedAdmin or null for none








getIsEnforcedIn2Sv
public Boolean getIsEnforcedIn2Sv()
Output only. Is 2-step verification enforced (Read-only)

Returns:
value or null for none








setIsEnforcedIn2Sv
public User setIsEnforcedIn2Sv(Boolean isEnforcedIn2Sv)
Output only. Is 2-step verification enforced (Read-only)

Parameters:
isEnforcedIn2Sv - isEnforcedIn2Sv or null for none








getIsEnrolledIn2Sv
public Boolean getIsEnrolledIn2Sv()
Output only. Is enrolled in 2-step verification (Read-only)

Returns:
value or null for none








setIsEnrolledIn2Sv
public User setIsEnrolledIn2Sv(Boolean isEnrolledIn2Sv)
Output only. Is enrolled in 2-step verification (Read-only)

Parameters:
isEnrolledIn2Sv - isEnrolledIn2Sv or null for none








getIsMailboxSetup
public Boolean getIsMailboxSetup()
Output only. Indicates if the user's Google mailbox is created. This property is only
 applicable if the user has been assigned a Gmail license.

Returns:
value or null for none








setIsMailboxSetup
public User setIsMailboxSetup(Boolean isMailboxSetup)
Output only. Indicates if the user's Google mailbox is created. This property is only
 applicable if the user has been assigned a Gmail license.

Parameters:
isMailboxSetup - isMailboxSetup or null for none








getKeywords
public Object getKeywords()
The user's keywords. The maximum allowed data size for this field is 1Kb.

Returns:
value or null for none








setKeywords
public User setKeywords(Object keywords)
The user's keywords. The maximum allowed data size for this field is 1Kb.

Parameters:
keywords - keywords or null for none








getKind
public String getKind()
Output only. The type of the API resource. For Users resources, the value is
 `admin#directory#user`.

Returns:
value or null for none








setKind
public User setKind(String kind)
Output only. The type of the API resource. For Users resources, the value is
 `admin#directory#user`.

Parameters:
kind - kind or null for none








getLanguages
public Object getLanguages()
The user's languages. The maximum allowed data size for this field is 1Kb.

Returns:
value or null for none








setLanguages
public User setLanguages(Object languages)
The user's languages. The maximum allowed data size for this field is 1Kb.

Parameters:
languages - languages or null for none








getLastLoginTime
public DateTime getLastLoginTime()
User's last login time. (Read-only)

Returns:
value or null for none








setLastLoginTime
public User setLastLoginTime(DateTime lastLoginTime)
User's last login time. (Read-only)

Parameters:
lastLoginTime - lastLoginTime or null for none








getLocations
public Object getLocations()
The user's locations. The maximum allowed data size for this field is 10Kb.

Returns:
value or null for none








setLocations
public User setLocations(Object locations)
The user's locations. The maximum allowed data size for this field is 10Kb.

Parameters:
locations - locations or null for none








getName
public UserName getName()
Holds the given and family names of the user, and the read-only `fullName` value. The maximum
 number of characters in the `givenName` and in the `familyName` values is 60. In addition, name
 values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9),
 dashes (-), forward slashes (/), and periods (.). For more information about character usage
 rules, see the [administration help center](https://support.google.com/a/answer/9193374).
 Maximum allowed data size for this field is 1Kb.

Returns:
value or null for none








setName
public User setName(UserName name)
Holds the given and family names of the user, and the read-only `fullName` value. The maximum
 number of characters in the `givenName` and in the `familyName` values is 60. In addition, name
 values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9),
 dashes (-), forward slashes (/), and periods (.). For more information about character usage
 rules, see the [administration help center](https://support.google.com/a/answer/9193374).
 Maximum allowed data size for this field is 1Kb.

Parameters:
name - name or null for none








getNonEditableAliases
public List<String> getNonEditableAliases()
Output only. List of the user's non-editable alias email addresses. These are typically outside
 the account's primary domain or sub-domain.

Returns:
value or null for none








setNonEditableAliases
public User setNonEditableAliases(List<String> nonEditableAliases)
Output only. List of the user's non-editable alias email addresses. These are typically outside
 the account's primary domain or sub-domain.

Parameters:
nonEditableAliases - nonEditableAliases or null for none








getNotes
public Object getNotes()
Notes for the user.

Returns:
value or null for none








setNotes
public User setNotes(Object notes)
Notes for the user.

Parameters:
notes - notes or null for none








getOrgUnitPath
public String getOrgUnitPath()
The full path of the parent organization associated with the user. If the parent organization
 is the top-level, it is represented as a forward slash (`/`).

Returns:
value or null for none








setOrgUnitPath
public User setOrgUnitPath(String orgUnitPath)
The full path of the parent organization associated with the user. If the parent organization
 is the top-level, it is represented as a forward slash (`/`).

Parameters:
orgUnitPath - orgUnitPath or null for none








getOrganizations
public Object getOrganizations()
A list of organizations the user belongs to. The maximum allowed data size for this field is
 10Kb.

Returns:
value or null for none








setOrganizations
public User setOrganizations(Object organizations)
A list of organizations the user belongs to. The maximum allowed data size for this field is
 10Kb.

Parameters:
organizations - organizations or null for none








getPassword
public String getPassword()
User's password

Returns:
value or null for none








setPassword
public User setPassword(String password)
User's password

Parameters:
password - password or null for none








getPhones
public Object getPhones()
A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.

Returns:
value or null for none








setPhones
public User setPhones(Object phones)
A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.

Parameters:
phones - phones or null for none








getPosixAccounts
public Object getPosixAccounts()
A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
 for the user.

Returns:
value or null for none








setPosixAccounts
public User setPosixAccounts(Object posixAccounts)
A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information
 for the user.

Parameters:
posixAccounts - posixAccounts or null for none








getPrimaryEmail
public String getPrimaryEmail()
The user's primary email address. This property is required in a request to create a user
 account. The `primaryEmail` must be unique and cannot be an alias of another user.

Returns:
value or null for none








setPrimaryEmail
public User setPrimaryEmail(String primaryEmail)
The user's primary email address. This property is required in a request to create a user
 account. The `primaryEmail` must be unique and cannot be an alias of another user.

Parameters:
primaryEmail - primaryEmail or null for none








getRecoveryEmail
public String getRecoveryEmail()
Recovery email of the user.

Returns:
value or null for none








setRecoveryEmail
public User setRecoveryEmail(String recoveryEmail)
Recovery email of the user.

Parameters:
recoveryEmail - recoveryEmail or null for none








getRecoveryPhone
public String getRecoveryPhone()
Recovery phone of the user. The phone number must be in the E.164 format, starting with the
 plus sign (+). Example: *+16506661212*.

Returns:
value or null for none








setRecoveryPhone
public User setRecoveryPhone(String recoveryPhone)
Recovery phone of the user. The phone number must be in the E.164 format, starting with the
 plus sign (+). Example: *+16506661212*.

Parameters:
recoveryPhone - recoveryPhone or null for none








getRelations
public Object getRelations()
A list of the user's relationships to other users. The maximum allowed data size for this field
 is 2Kb.

Returns:
value or null for none








setRelations
public User setRelations(Object relations)
A list of the user's relationships to other users. The maximum allowed data size for this field
 is 2Kb.

Parameters:
relations - relations or null for none








getSshPublicKeys
public Object getSshPublicKeys()
A list of SSH public keys.

Returns:
value or null for none








setSshPublicKeys
public User setSshPublicKeys(Object sshPublicKeys)
A list of SSH public keys.

Parameters:
sshPublicKeys - sshPublicKeys or null for none








getSuspended
public Boolean getSuspended()
Indicates if user is suspended.

Returns:
value or null for none








setSuspended
public User setSuspended(Boolean suspended)
Indicates if user is suspended.

Parameters:
suspended - suspended or null for none








getSuspensionReason
public String getSuspensionReason()
Output only. Has the reason a user account is suspended either by the administrator or by
 Google at the time of suspension. The property is returned only if the `suspended` property is
 `true`.

Returns:
value or null for none








setSuspensionReason
public User setSuspensionReason(String suspensionReason)
Output only. Has the reason a user account is suspended either by the administrator or by
 Google at the time of suspension. The property is returned only if the `suspended` property is
 `true`.

Parameters:
suspensionReason - suspensionReason or null for none








getThumbnailPhotoEtag
public String getThumbnailPhotoEtag()
Output only. ETag of the user's photo (Read-only)

Returns:
value or null for none








setThumbnailPhotoEtag
public User setThumbnailPhotoEtag(String thumbnailPhotoEtag)
Output only. ETag of the user's photo (Read-only)

Parameters:
thumbnailPhotoEtag - thumbnailPhotoEtag or null for none








getThumbnailPhotoUrl
public String getThumbnailPhotoUrl()
Output only. Photo Url of the user (Read-only)

Returns:
value or null for none








setThumbnailPhotoUrl
public User setThumbnailPhotoUrl(String thumbnailPhotoUrl)
Output only. Photo Url of the user (Read-only)

Parameters:
thumbnailPhotoUrl - thumbnailPhotoUrl or null for none








getWebsites
public Object getWebsites()
The user's websites. The maximum allowed data size for this field is 2Kb.

Returns:
value or null for none








setWebsites
public User setWebsites(Object websites)
The user's websites. The maximum allowed data size for this field is 2Kb.

Parameters:
websites - websites or null for none








set
public User set(String fieldName,
                Object value)

Overrides:
set in class GenericJson








clone
public User clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.