Profile

Represents a profile, which defines a set of permissions to perform different operations, such as querying, adding, updating, or deleting information.

Supported Calls

delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Special Access Rules

Fields

Field Details
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the profile.
IsSsoEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If true, users assigned to this profile can delegate username and password authentication to a corporate database instead of the user database.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this profile. Available in API version 29.0 and later.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this profile. Available in API version 29.0 and later.
Name
Type
string
Properties
Filter, Group, Sort, Update
Description
The name of the profile.
PermissionsPermissionName
Type
boolean
Properties
Filter, Update
Description
One field for each permission. If true, users assigned to this profile have the named permission. The number of fields varies depending on the permissions for the organization and license type.
Tip
To get a list of available permissions in the SOAP API, use describeSObjects().
UserLicenseId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the UserLicense associated with this profile.
UserType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
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.
UserType replaces LicenseType, which is unavailable as of API version 10.0. In API versions 8.0 and 9.0 LicenseType is still available with the following valid values:
  • AUL: Force.com user license. Label is Apex Platform.
  • AUL1: Force.com user license with only one user. Label is Apex Platform One.
  • Salesforce: Salesforce user license. Label is Salesforce.
  • PackageManager: user who can create and work with managed packages for Force.com AppExchange. Label is Package Manager.
  • 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.
  • CustomerUser: 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.
  • CustomerManager: 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.

Usage

Use the Profile object to query the set of currently configured user profiles in your organization. Your client application can use Profile objects to obtain valid profile IDs for use when querying or modifying users through the API.

In the user interface, profiles can be used to assign user licenses from specific pools (Force.com Platform user license or Salesforce user license, for example). If a user is assigned to a profile with a different license type, the number of available licenses in the old license type pool increases, one per user changed, and decreases by the same amount in the new license type pool.

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