User

Represents a user in your organization.

Supported Calls

create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()

Special Access Rules

Fields

Field Details
AboutMe
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Information about the user, such as areas of interest or skills.
AccountId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the Account associated with a Customer Portal user.

This field is null for Salesforce users.

Address (beta)
Type
address
Properties
Filter, Nillable
Description
The compound form of the address. Read-only. See Address Compound Fields for details on compound address fields.
Alias
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The user’s alias. For example, jsmith.
BadgeText
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The text description of a user badge that appears over a user’s photo. Users of the same Chatter user type (internal, external) are badged. Different user types are not badged.
CallCenterId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If Salesforce CRM Call Center is enabled, represents the call center to which this user is assigned.
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city associated with the user. Up to 40 characters allowed.
CommunityNickname
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Name used to identify this user in the Community application, which includes the ideas and answers features.
CompanyName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the user’s company.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
ID of the Contact associated with this account. The contact must have a value in the AccountId field or an error occurs.
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country associated with the user. Up to 80 characters allowed.
CountryCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO country code associated with the user.
CurrentStatus
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Text that describes what the user is working on.
Note
If you update this field, the API automatically adds a post of type UserStatus on the user’s profile in Chatter.

This field is deprecated in API version 25.0. To achieve similar behavior, post to the user directly by creating a FeedItem with the user’s ParentId.

DefaultCurrencyIsoCode
Type
picklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
The user's default currency setting for new records. For example, a user in France could have a DefaultCurrencyIsoCode set to Euros, and that would be their default currency in the application.

Only applicable for organizations that use multiple currencies.

DefaultDivision
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
This record’s default division. Only applicable if divisions are enabled for your organization.
DefaultGroupNotificationFrequency
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Required. The default frequency for sending the user's Chatter group email notifications when the user joins groups. The valid values are:
  • PEmail on each post
  • D—Daily digests
  • W—Weekly digests
  • N—Never
The default value is N. For Professional, Enterprise, Unlimited, and Developer Edition organizations that existed prior to API version 22.0, the default value remains D.

This field is available in API version 21.0 and later.

DelegatedApproverId
Type
reference
Properties
Create, Filter, Group, Nillable,Sort, Update
Description
Id of the user who is a delegated approver for this user.
Department
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The company department associated with the user.
DigestFrequency
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Required. The frequency at which the system sends the user’s Chatter personal email digest. The valid values are:
  • D = Daily
  • W = Weekly
  • N = Never
The default value is D.
Division
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The division associated with this user, similar to Department and unrelated to DefaultDivision.
Email
Type
email
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The user’s email address.
EmailEncodingKey
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The email encoding for the user, such as ISO-8859-1 or UTF-8.
EmailPreferencesAutoBcc
Type
boolean
Properties
Create, Filter, Update
Description
Determines whether the user will receive copies of sent emails. This option applies only if compliance BCC emails are not enabled.
EmailPreferencesAutoBccStayInTouch
Type
boolean
Properties
Create, Filter, Update
Description
Determines whether the user will receive copies of sent Stay-in-Touch emails. This option applies only if compliance BCC emails are not enabled.
EmailPreferencesStayInTouchReminder
Type
boolean
Properties
Create, Filter, Update
Description
Determines whether the user is reminded to use the Stay-in-Touch feature when creating a new contact.
EmployeeNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s employee number.
Extension
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s phone extension number.
Fax
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s fax number.
FederationIdentifier
Type
string
Properties
Create, Filter, idLookup, Nillable, Sort, Update
Description
Indicates the value that must be listed in the Subject element of a Security Assertion Markup Language (SAML) IDP certificate to authenticate the user for a client application using single sign-on. This value must be specified if the SAML User ID Type is Assertion contains Federation ID from the User record. Otherwise, this field can’t be edited.
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s first name.
ForecastEnabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user is enabled as a Forecast Manager (true) or not (false) in customizable forecasting. Forecast managers see forecast rollups from users below them in the forecast hierarchy.
FullPhotoUrl
Type
string
Properties
Filter, Nillable, Sort
Description
The URL for the user's profile photo if Chatter is enabled.

The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.

This field is available in API version 20.0 and later.

IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user has access to log in (true) or not (false). You can modify a User's active status from the user interface or via the API.
IsBadged
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the user is visually badged (true) or not (false). Users of the same Chatter user type (internal, external) are badged. Different user types are not badged.
IsPartner
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the user is a partner who has access to the partner portal (true) or not (false). This field is not available for release 9.0 and later. Instead, use UserType with the value Partner or Power Partner.
IsPortalEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user has access to partner portal, Customer Portal, or Communities (true) or not (false).

This field is only available if partner relationship management (partner portal) or Customer Portal is enabled, OR if Communities is enabled and you have partner portal, Customer Portal, or High-Volume Portal User licenses.

IsPortalSelfRegistered
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort
Description
Indicates whether the user is a Customer Portal user who self-registered for your organization's Customer Portal (true) or not (false). This field is not available for release 9.0 and earlier.
IsPrmSuperUser
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user has super user access in the partner portal (true) or not (false).

This field is available in API version 24.0 and later.

Note
This field is not automatically enabled. Contact Salesforce to enable this field.
JigsawImportLimitOverride
Type
int
Properties
Create, Filter, Group Nillable, Sort, Update
Description
The Data.com user’s monthly addition limit. The value must be between zero and the organization’s monthly addition limit. Label is Data.com Monthly Addition Limit. This field is available in API version 27.0 and later.
LanguageLocaleKey
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The user’s language, such as “French” or “Chinese (Traditional).” Label is Language.
LastLoginDate
Type
dateTime
Properties
Filter, Sort, Nillable
Description
The date and time when the user last logged in.
LastName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The user’s last name.
LastReferencedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Latitude (beta)
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of an address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
LocaleSidKey
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. This field is a restricted picklist field. The value of the field affects formatting and parsing of values, especially numeric values, in the user interface. It does not affect the API.

The field values are named according to the language, and country if necessary, using two-letter ISO codes. The set of names is based on the ISO standard. It can often be more convenient to manually set a user’s locale in the user interface, and then use that value for inserting or updating other users via the API.

Longitude (beta)
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
Manager
Type
picklist
Properties
Create, Filter, Restricted picklist, Update
Description
User lookup field used to select the user's manager. This establishes a hierarchical relationship, preventing you from selecting a user that directly or indirectly reports to itself.
ManagerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Id of the user who manages this user.
MiddleName (beta)
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s middle name. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
MobilePhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s mobile or cellular phone number.
Name
Type
string
Properties
Filter, Group, Sort
Description
Concatenation of FirstName and LastName. Limited to 121 characters.
OfflineTrialExpirationDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the user’s Connect Offline trial expires.
Phone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s phone number.
PortalRole
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort
Description
The role of the user in the Customer Portal (either Executive, Manager, User, or PersonAcount).

Prior to API version 16.0, you could set this field to null and the system automatically included a portal role. In API version 16.0 and above, when you set this field to null, a portal role is not automatically created. When this field is null and a ContactId is provided, the user is assigned to the User role.

The field is available if Customer Portal is enabled OR Communities is enabled and have available partner portal, Customer Portal, or High-Volume Portal User licenses.

PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s postal or ZIP code. Label is Zip/Postal Code.
ProfileId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. ID of the user’s Profile. Use this value to cache metadata based on profile. In earlier releases, this was RoleId.
ReceivesAdminInfoEmails
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user receives email for administrators from Salesforce (true) or not (false).
ReceivesInfoEmails
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user receives informational email from Salesforce (true) or not (false).
SenderEmail
Type
email
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The email address used as the From address when the user sends emails. This is the same value shown in Setup on the My Email Settings page.
SenderName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name used as the email sender when the user sends emails. This is the same value shown in Setup on the My Email Settings page.
Signature
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The signature text added to emails. This is the same value shown in Setup on the My Email Settings page.
SmallPhotoUrl
Type
string
Properties
Filter, Nillable, Sort
Description
The URL for a thumbnail of the user's profile photo if Chatter is enabled.

The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.

This field is available in API version 20.0 and later.

State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state associated with the User. Up to 80 characters allowed.
StateCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ISO state code associated with the user.
StayInTouchNote
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The body specified for the Stay-in-Touch email.
StayInTouchSignature
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The signature specified for the Stay-in-Touch email.
StayInTouchSubject
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The subject specified for the Stay-in-Touch email.
Street
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street address associated with the User.
Suffix (beta)
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s name suffix. Maximum size is 40 characters. Contact Salesforce Customer Support to enable this field.
TimeZoneSidKey
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. This field is a restricted picklist field. A User time zone affects the offset used when displaying or entering times in the user interface. However, the API does not use a User time zone when querying or setting values.

Values for this field are named using region and key city, according to ISO standards. It can often be more convenient to manually set one User time zone in the user interface, and then use that value for creating or updating other User records via the API.

Title
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user’s business title, such as “Vice President.”
Username
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Contains the name that a user enters to log into the API or the user interface. The value for this field must be in the form of an email address. It must also be unique across all organizations. If you try to create or update a User with a duplicate value for this field, the operation is rejected.

Each inserted User also counts as a license. Every organization has a maximum number of licenses. If you attempt to exceed the maximum number of licenses by inserting User records, the create is rejected.

UserPermissionsCallCenterAutoLogin
Type
boolean
Properties
Create, Filter, Update
Description
Required if Salesforce CRM Call Center is enabled. Indicates whether the user is enabled to use the auto login feature of the call center (true) or not (false).
UserPermissionsChatterAnswersUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the portal user is enabled to use the Chatter Answers feature (true) or not (false). This field defaults to false when a Customer Portal user is created from the API.
UserPermissionsInteractionUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user can run flows or not. Label is Force.com Flow User.
UserPermissionsJigsawProspectingUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Data.com user license (true) or not (false). The Data.com user license lets the user add Data.com contact and lead records to Salesforce in supported editions. Label is Data.com User.
UserPermissionsKnowledgeUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is enabled to use Salesforce Knowledge (true) or not (false). Label is Knowledge User.
UserPermissionsMarketingUser
Type
boolean
Properties
Create, Filter, Update
Description
Required. Indicates whether the user is enabled to manage campaigns in the user interface (true) or not (false). Label is Marketing User.
UserPermissionsMobileUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Salesforce Classic license (true) or not (false). Label is Apex Mobile User. The Salesforce Classic license grants the user access to the Salesforce Classic application on supported mobile devices.
UserPermissionsOfflineUser
Type
boolean
Properties
Create, Filter, Update
Description
Required. Indicates whether the user is enabled to use Offline Edition (true) or not (false). Label is Offline User.
UserPermissionsSFContentUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Salesforce CRM Content User License (true) or not (false). Label is Salesforce CRM Content User. The Salesforce CRM Content User license grants the user access to the Salesforce CRM Content application.
UserPermissionsSiteforceContributorUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Site.com Contributor feature license (true) or not (false). Label is Site.com Contributor User. The Site.com Contributor feature license grants the user access to the Site.com application. Users with a Contributor license can use Site.com Studio to edit site content only.
UserPermissionsSiteforcePublisherUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Site.com Publisher feature license (true) or not (false). Label is Site.com Publisher User. The Site.com Publisher feature license grants the user access to the Site.com application. Users with a Publisher license can build and style websites, control the layout and functionality of pages and page elements, and add and edit content.
UserPermissionsSupportUser
Type
boolean
Properties
Create, Filter, Update
Description
When true, the user can use the Salesforce console.
UserPermissionsWirelessUser
Type
boolean
Properties
Create, Update
Description
Required if the Wireless permission is enabled for your organization. Indicates whether the user is enabled to use Wireless Edition (true) or not (false). Label is Wireless User.
Note
As of November 2005, Salesforce Wireless Edition is no longer available for purchase. If you are a Professional Edition customer and purchased Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has signed or renewed your Salesforce contract prior to November 7, 2005, you may continue using Wireless Edition through the end of your existing contract term.
UserPermissionsWorkDotComUserFeature
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the Work.com feature is enabled for the user (true) or not (false).
UserPreferencesActivityRemindersPopup
Type
boolean
Properties
Create, Filter, Update
Description
When true, a reminder popup window automatically opens when an activity reminder is due. Corresponds to the Trigger alert when reminder comes due checkbox at the Reminders page in the personal settings in the user interface.
UserPreferencesApexPagesDeveloperMode
Type
boolean
Properties
Create, Filter, Update
Description
When true, indicates the user has enabled developer mode for editing Visualforce pages and controllers.
UserPreferencesContentEmailAsAndWhen
Type
boolean
Properties
Create, Filter, Update
Description
When false, a user with Salesforce CRM Content subscriptions will receive a once daily email summary if activity occurs on his or her subscribed content, libraries, tags, or authors. To receive email, the UserPreferencesContentNoEmail field must also be false.

The default value is false.

Note
This field is only visible when Salesforce CRM Content is enabled for your organization.
UserPreferencesContentNoEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, a user with Salesforce CRM Content subscriptions will receive email notifications if activity occurs on his or her subscribed content, libraries, tags, or authors. To receive real-time email alerts, set this field to false and set the UserPreferencesContentEmailAsAndWhen field to true.

The default value is false.

Note
This field is only visible when Salesforce CRM Content is enabled for your organization.
UserPreferencesEnableAutoSubForFeeds
Type
boolean
Properties
Create, Filter, Update
Description
When true, the user automatically subscribes to feeds for any objects that the user creates. This field is available in API version 25.0 and later.
UserPreferencesDisableAllFeedsEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email for all updates to Chatter feeds, based on the types of feed emails and digests the user has enabled. This field is available in API version 24.0 and later.
UserPreferencesDisableAutoSubForFeeds
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically subscribes to feeds for any objects that the user creates. This field is deprecated in API version 25.0 and later. Starting with API version 25.0, use UserPreferencesEnableAutoSubForFeeds to enable or disable auto-follow for objects a user creates.
UserPreferencesDisableBookmarkEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone comments on a Chatter feed item after the user has bookmarked it. This field is available in API version 24.0 and later.
UserPreferencesDisableChangeCommentEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone comments on a change the user has made, such as an update to their profile. This field is available in API version 24.0 and later.
UserPreferencesDisableEndorsementEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the member automatically receives email every time someone endorses them for a topic.
UserPreferencesDisableFileShareNotificationsForApi
Type
boolean
Properties
Create, Filter, Update
Description
When false, email notifications are sent from the person who has shared a file to the users with whom the file has been shared. This field is available in API version 25.0 and later.
UserPreferencesDisableFollowersEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone starts following the user in Chatter.This field is available in API version 24.0 and later.
UserPreferencesDisableLaterCommentEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone comments on a feed item after the user has commented on the feed item. This field is available in API version 24.0 and later.
UserPreferencesDisableLikeEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone likes a post or comment the user has made. This field is available in API version 24.0 and later.
UserPreferencesDisableMentionsPostEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time the user is mentioned in posts. This field is available in API version 24.0 and later.
UserPreferencesDisableProfilePostEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone posts to the user’s profile. This field is available in API version 24.0 and later.
UserPreferencesDisableSharePostEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time the user’s post is shared. This field is available in API version 24.0 and later.
UserPreferencesDisableFeedbackEmail
Type
boolean
Properties
Filter
Description
When false, the user automatically receives emails related to Work.com feedback. This includes when someone requests or offers feedback, shares feedback with the user, or reminds the user to answer a feedback request.
UserPreferencesDisCommentAfterLikeEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone comments on a post the user has liked. This field is available in API version 24.0 and later.
UserPreferencesDisMentionsCommentEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time the user is mentioned in comments. This field is available in API version 24.0 and later.
UserPreferencesDisableMessageEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email for Chatter messages sent to the user. This field is available in API version 24.0 and later.
UserPreferencesDisableRewardEmail
Type
boolean
Properties
Filter
Description
When false, the user automatically receives emails related to Work.com rewards. This includes when someone someone gives a reward to the user.
UserPreferencesDisableWorkEmail
Type
boolean
Properties
Filter
Description
When false, the user receives emails related to Work.com feedback, goals, and coaching. The user must also sign up for individual emails listed on the Work.com email settings page. When true, the user will not receive any emails related to Work.com feedback, goals, or coaching even if they are signed up for individual emails.
UserPreferencesDisProfPostCommentEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically receives email every time someone comments on posts on the user’s profile. This field is available in API version 24.0 and later.
UserPreferencesEventRemindersCheckboxDefault
Type
boolean
Properties
Create, Filter, Update
Description
When true, a reminder popup is automatically set on the user's events. Corresponds to the By default, set reminder on Events to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
UserPreferencesHideChatterOnboardingSplash
Type
boolean
Properties
Filter
Description
When true, the initial Chatter onboarding prompts do not appear.
UserPreferencesHideCSNDesktopTask
Type
boolean
Properties
Create, Filter, Update
Description
When true, the Chatter recommendations panel never displays the recommendation to install Chatter Desktop. This field is available in API version 26.0 and later.
UserPreferencesHideCSNGetChatterMobileTask
Type
boolean
Properties
Create, Filter, Update
Description
When true, the Chatter recommendations panel never displays the recommendation to install Chatter Mobile. This field is available in API version 26.0 and later.
UserPreferencesHideSecondChatterOnboardingSplash
Type
boolean
Properties
Filter
Description
When true, the secondary Chatter onboarding prompts do not appear.
UserPreferencesHideS1BrowserUI
Type
boolean
Properties
Create, Filter, Update
Description
Controls the interface that the user sees when logging in to Salesforce from a supported mobile browser. If false, the user is automatically redirected to the Salesforce1 mobile browser app. If true, the user sees the full Salesforce site. The default value is false. Label is Salesforce1 User.

This field is available in API version 29.0 or later.

UserPreferencesJigsawListUser
Type
boolean
Properties
Create, Filter, Update
Description
When true, the user is a Data.com List user and, therefore, shares record additions from a pool. UserPermissionsJigsawProspectingUser must also be set to true. Label is Data.com List User. This field is available in API version 27.0 and later.
UserPreferencesOptOutOfTouch
Type
boolean
Properties
Create, Filter, Update
Description
This field is deprecated in API version 29.0. When false, the user automatically accesses the Salesforce Touch app when logging in to Salesforce from an iPad. If true, automatic access to the Salesforce Touch app is turned off and the user’s iPad is directed to the full Salesforce site instead. The default value is false.
Note

Salesforce Touch must be enabled before this field is visible.

UserPreferencesReminderSoundOff
Type
boolean
Properties
Create, Filter, Update
Description
When true, a sound automatically plays when an activity reminder is due. Corresponds to the Play a reminder sound checkbox on the Reminders page in the user interface.
UserPreferencesShowCityToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the city field in the user’s contact information. City is visible only to internal members of the user’s organization when:
  • This field is false. When false, this field returns the value #N/A.
City is visible to external members in a community when:
  • This field is true, or
  • This field is false but UserPreferencesShowCityToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses.

The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowCityToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the city field in the user’s contact information. When true, city is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.

When true, this field overrides the value false in UserPreferencesShowCityToExternalUsers, making the user’s city visible to external members.

The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowCountryToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the country field in the user’s contact information. Country is visible only to internal members of the user’s organization when:
  • This field is false. When false, this field returns the value #N/A.
Country is visible to external members in a community when:
  • This field is true, or
  • This field is false but UserPreferencesShowCountryToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses.

The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowCountryToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the country field in the user’s contact information. When true, country is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.

When true, this field overrides the value false in UserPreferencesShowCountryToExternalUsers, making the user’s country visible to external members.

The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowEmailToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the email address field in the user’s contact information. Email address is visible only to internal members of the user’s organization when this field is false. Email address is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowFaxToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the fax number field in the user’s contact information. Fax number is visible only to internal members of the user’s organization when this field is false. Fax number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowManagerToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the manager field in the user’s contact information. Manager is visible only to internal members of the user’s organization when this field is false. Manager is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowMobilePhoneToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the mobile or cellular phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowPostalCodeToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the postal or ZIP code field in the user’s contact information. Postal code is visible only to internal members of the user’s organization when:
  • This field is false. When false, this field returns the value #N/A.
Postal code is visible to external members in a community when:
  • This field is true, or
  • This field is false but UserPreferencesShowPostalCodeToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses.

The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowPostalCodeToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the postal or ZIP code field in the user’s contact information. When true, postal code is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.

When true, this field overrides the value ​false in UserPreferencesShowPostalCodeToExternalUsers, making the user’s postal code visible to external members.

The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowProfilePicToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the user’s profile photo. When true, the photo is visible to guest users in a community. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community.

When false, this field returns the stock photo. The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowStateToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the state field in the user’s contact information. State is visible only to internal members of the user’s organization when:
  • This field is false. When false, this field returns the value #N/A.
State is visible to external members in a community when:
  • This field is true, or
  • This field is false but UserPreferencesShowStateToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowStateToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the state field in the user’s contact information. When true, state is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.

When true, this field overrides the value false in UserPreferencesShowStateToExternalUsers, making the user’s state visible to external members.

The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowStreetAddressToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the street address field in the user’s contact information. The address is visible only to internal members of the user’s organization when this field is false. The address is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesShowTitleToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the business title field in the user’s contact information. Title is visible only to internal members of the user’s organization when:
  • This field is false. When false, this field returns the value #N/A.
Title is visible to external members in a community when:
  • This field is true, or
  • This field is false but UserPreferencesShowTitleToGuestUsers is true, which overrides this field’s value.
External users are users with Community, Customer Portal, or partner portal licenses.

The default value is true. This field is available in API version 26.0 and later.

UserPreferencesShowTitleToGuestUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the business title field in the user’s contact information. When true, title is visible to guest users. Guest users can access public Site.com and Force.com sites, and public pages in Communities, via the Guest User license associated with each site or community. When false, this field returns the value #N/A.

When true, this field overrides the value false in UserPreferencesShowTitleToExternalUsers, making the user’s title visible to external members.

The default value is false. This field is available in API version 28.0 and later.

UserPreferencesShowWorkPhoneToExternalUsers
Type
boolean
Properties
Create, Filter, Update
Description
Indicates the visibility of the work phone number field in the user’s contact information. The number is visible only to internal members of the user’s organization when this field is false. The number is visible to external members in a community when this field is true. External users are users with Community, Customer Portal, or partner portal licenses.

When false, this field returns the value #N/A. The default value is false. This field is available in API version 26.0 and later.

UserPreferencesTaskRemindersCheckboxDefault
Type
boolean
Properties
Create, Filter, Update
Description
When true, a reminder popup is automatically set on the user's tasks. Corresponds to the By default, set reminder on Tasks to... checkbox on the Reminders page in the user interface. This field is related to UserPreference and customizing activity reminders.
UserRoleId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the user’s UserRole. Label is Role ID.
UserType
Type
picklist
Properties
Filter, Group, Nillable, Sort, Restricted picklist
Description
The category of user license. Each UserType is associated with one or more UserLicense records. Each UserLicense is associated with one or more profiles. In API version 10.0 and later, valid values include:
  • Standard: user license. This user type also includes Salesforce Platform and Salesforce Platform One user licenses. Label is Standard.
  • PowerPartner: User whose access is limited because he or she is a partner and typically accesses the application through a partner portal or community. Label is Partner.
  • CSPLitePortal: user whose access is limited because he or she is an organization's customer and accesses the application through aCustomer Portal or community. Label is High Volume Portal.
  • CustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal User.
  • PowerCustomerSuccess: user whose access is limited because he or she is an organization's customer and accesses the application through a Customer Portal. Label is Customer Portal Manager.

    Users with this license type can view and edit data they directly own or data owned by or shared with users below them in the Customer Portal role hierarchy.

  • CsnOnly: user whose access to the application is limited to Chatter. This user type includes Chatter Free and Chatter moderator users. Label is Chatter Free.
WirelessEmail
Type
email
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Wireless email address associated with this user. For use with Salesforce Wireless Edition. This field is available only if the Wireless and Email permissions are enabled for your organization.
Note
As of November 2005, Salesforce Wireless Edition is no longer available for purchase. If you are a Professional Edition customer and purchased Wireless Edition prior to November 7, 2005 or are an Enterprise Edition customer who has signed or renewed your Salesforce contract prior to November 7, 2005, you may continue using Wireless Edition through the end of your existing contract term.

Usage

Use this object to query information about users and to provision and modify users in your organization. Unlike other objects, the records in the User table represent actual users—not data owned by users. Any user can query or describe User records.

For example, the following SOQL code finds users with a particular user role.

SELECT Id, Username 
FROM User 
WHERE UserRoleId='00ED0000000xicT'

Each portal user is associated with a portal account. A portal account can have a maximum of three portal roles (Executive, Manager, and User). You can select the default number of roles to be created from the user interface. The role hierarchy is maintained when you insert and delete portal roles, and roles are created bottom-up. Deleting the User role causes the Manager role to be renamed to User role. Deleting both the Executive and User roles causes the Manager role to be renamed to User role. Before deleting a role, you must assign users under that role to another role.

Deactivate Users

You can’t delete a user in the user interface or the API. You can deactivate a user in the user interface; and you can deactivate or disable a Customer Portal or partner portal user in the user interface or the API. Because users can never be deleted, we recommend that you exercise caution when creating them.

If you deactivate a user, any EntitySubscription where the user is associated with the ParentId or SubscriberId field, meaning all subscriptions both to and from the user, are soft deleted. If the user is reactivated, the subscriptions are restored. However, if you deactivate multiple users at once and these users follow each other, their subscriptions are hard deleted. In this case, the user-to-user EntitySubscription is deleted twice (double deleted). Such subscriptions can’t be restored upon user reactivation.

Passwords

For security reasons, you can’t query User passwords via the API or the user interface. However, the API allows you to set and “reset” User passwords using the setPassword() and resetPassword() calls. The password lockout status and the ability to reset the User locked-out status is not available via the API. You must check and reset the User password lockout status using the user interface.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.