Profile

Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.

Version 

Introduced in API version 32.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

GET, HEAD, Query

Special Access Rules 

• As of Summer ’20 and later, Customer Portal and Partner Portal users cannot access this object.

  • Client settings
  • Field permissions
  • Layout assignments
  • Object permissions
  • Permission dependencies
  • Permission set tab settings
  • Permission set group components
  • Record types

• As of API version 50.0 and later, only users with correct permissions can view profile names other than their own if the Profile Filtering setting is enabled.

  Profile names are also exposed when users with permissions to perform the following tasks take these actions:

  Important

• Create a tab or record type with a wizard step that includes the assignment of tabs and record types to profiles.

• Configure a login flow where viewing profile lists is required to make flow associations.

• Set up delegated admins where looking up profiles is needed to identify assignable profiles.

• Administer an org as a delegated customer admin.

• Administer an org as a delegated admin to view and assign profiles of the delegated group. :::

Fields 

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 7.0

• Description: The profile description, limited to 255 characters.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 32.0

• Description: The unique profile name. Use this name when creating the profile, before you have an ID. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 32.0

• Description: The profile metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Name 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The profile name.

UserLicenseId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 10.0