To create or update a User record, you must log in with the “Manage Users”
permission. Additionally, if the user is a Customer Portal user, you must log in with the “Edit Self-Service Users” permission; and if the user is a partner portal user, you must log in with the “Manage Partners”
permission.
Customer Portal users can only view Customer Portal users in the account with which they are associated.
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.
Alias
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The user’s alias. For example, jsmith.
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.
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.
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.
However, the User object could have currency custom fields stored
in a different currency.
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.
Required. The default frequency for
sending the user's Chatter group email notifications when the user joins groups. The valid
values are:
P—Email 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.
Required. The email encoding for the user, such as ISO-8859-1 or UTF-8.
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, 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.
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 PRM.
IsPortalEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the user has access to the partner portal or Customer Portal (true) or not (false).
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.
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.
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.
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.
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.com (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.com (true) or not (false).
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.
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, 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).
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 Jigsaw user license
(true) or not (false). The Jigsaw user license lets
the user add Jigsaw contact and lead records to Salesforce in supported editions. Label is Jigsaw 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 online application (true) or not (false). Label is Marketing User.
UserPermissionsMobileUser
Type
boolean
Properties
Create, Filter, Update
Description
Indicates whether the user is allocated one Salesforce Mobile license (true) or not (false). Label is Mobile User. The Salesforce Mobile license grants the user access to the Salesforce Mobile 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 User. The Salesforce CRM Content User
license grants the user access to the Salesforce CRM Content application.
UserPermissionsSupportUser
Type
boolean
Properties
Create, Filter, Update
Description
When true, the user can use
the Service Cloud
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.
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 Your Name | Setup | My Personal Information | Reminders 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.
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.
UserPreferencesDisableAllFeedsEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically
receives email for all updates to Chatter feeds. 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 they create.
UserPreferencesDisableBookmarkEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically
receives email for all comments made to a Chatter feed item after a 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 for all comments made on a user’s change, such
as an update to their profile. This field is available in API version
24.0 and later.
UserPreferencesDisableFollowersEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically
receives email for all updates to all the Chatter users currently being followed.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 for all comments made 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 for all comments made on a feed item after the user
has liked the feed item. 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 for all mentions made of the user 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 for all posts made 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.
UserPreferencesDisCommentAfterLikeEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically
receives email every time someone makes a comment to 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 for all mentions made of the user 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.
UserPreferencesDisProfPostCommentEmail
Type
boolean
Properties
Create, Filter, Update
Description
When false, the user automatically
receives email for comments made on user profile posts. 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 Your Name | Setup | My Personal Information | Reminders in the online application. This field is related to UserPreference and customizing activity reminders.
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 at Your Name | Setup | My Personal Information | Reminders in the online application. This field is related to UserPreference and customizing activity reminders.
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 at Your Name | Setup | My Personal Information | Reminders in the online application.
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: PRM user whose access is limited because he or she
is a partner and typically accesses the application through a partner
portal. 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. 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.
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.
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.
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 portalUser in the user interface or the API.
Because a User can never be deleted, we recommend that you exercise caution
when creating them.
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.