{"id":"meta_profile","title":"Profile","content":"

Profile

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

In API version 29.0 and later, you can retrieve and\n deploy access settings for these managed components in profiles and permission\n sets:

\n\n \n\n

In API version 51.0 and later, you can retrieve and deploy access settings for login\n flows. For more information, see Managed Component Access in the Components in a\n Module section of Sample\n package.xml Manifest Files.

\n\n

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

\n\n
\n\"Important\"
\n

Important

\n

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

    \n
  • Create a tab or record type with a wizard step that includes the assignment\n of tabs and record types to profiles.
    • \n\n
  • Configure a login flow where viewing profile lists is required to make flow\n associations.
    • \n\n
  • Set up delegated admins where looking up profiles is needed to identify\n assignable profiles.
    • \n\n
  • Administer an org as a delegated customer admin.
    • \n\n
  • Administer an org as a delegated admin to view and assign profiles of the\n delegated group.
    • \n\n
\n

\n
\n
\n\n
\n\n
\n

Declarative Metadata File Suffix and Directory Location

\n\n \n

The file suffix is .profile. There's one file for each profile,\n stored in the profiles folder in the corresponding package\n directory.

\n\n
\n\n
\n

Version

\n\n \n

Profiles are available in API version 10.0 and later.

\n\n
\n\n
\n

Special Access Rules

\n
\n

As of Summer ’20 and later, Customer Portal\n and Partner Portal users can’t access this type.

\nTo view the following settings,\n assignments, and permissions for standard and custom objects in a specified profile, the\n View Setup and Configuration permission is required.
    \n
  • Client settings
    • \n\n
  • Field permissions
    • \n\n
  • Layout assignments
    • \n\n
  • Object permissions
    • \n\n
  • Permission dependencies
    • \n\n
  • Permission set tab settings
    • \n\n
  • Permission set group components
    • \n\n
  • Record types
    • \n\n
\n
\n
\n\n
\n

Fields

\n\n \n

The content of a profile returned by Metadata API depends on the content requested in\n the RetrieveRequest message. For example,\n profiles only include field-level security for fields included in custom objects\n returned in the same RetrieveRequest as the\n profiles. The\n profile definition contains the following fields:

\n
\n\"Important\"
\n

Important

\n

We designed Profile metadata deployment to overlay the existing Profile\n settings in a target org. For example, if you disable permissions for a profile, the\n newly disabled permission information isn't exported. To force all Profile changes\n to deploy through metadata, including permission disablement, add code that\n explicitly indicates disabled permissions. For example, add this code to the Profile\n metadata .xml file before deploying into a target org: <value>false</value>.

If you deploy\n a profile that doesn’t exist in the target org and don't specify any permissions\n or settings, then the resulting profile contains all permissions and settings in\n the standard Minimum Access - Salesforce profile (API version 60.0 and later) or\n the standard Standard User profile (API version 59.0 and earlier).

\n

\n
\n
\n
\n\"Note\"
\n

Note

\n

As of API version\n 38.0, you can change field permissions to make a field editable using the\n Metadata API for fields that you can't change through the user interface. For\n example, you can deploy Asset.ProductCode\n as an editable field even though you can't through the user interface.

\n
\n
\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField Type Description
agentAccesses\nProfileAgentAccess[]Indicates which agents are visible to users assigned to this\n profile. Available in API version 63.0 and later.
applicationVisibilities\nProfileApplicationVisibility[]Indicates which apps are visible to users assigned to this\n profile. In API version 29.0 and earlier, this field supports custom\n apps only. In API version 30.0 and later, this field supports both\n standard and custom apps.
categoryGroupVisibilities\nProfileCategoryGroupVisibility[]Indicates which data category groups are visible to users\n assigned to this profile. Available in API version 41.0 and\n later.
classAccesses\nProfileApexClassAccess[]Indicates which top-level Apex classes have methods that users\n assigned to this profile can execute.
custombooleanIndicates whether the profile is a custom (true) or standard (false) profile. Available in API\n version 30.0 and later.
customMetadataTypeAccesses\nProfileCustomMetadataTypeAccess[]Indicates the custom metadata types that are read-accessible to a\n user assigned to this profile. Available in API version 47.0 and\n later.
customPermissions\nProfileCustomPermissions[]Indicates which custom permissions are available to users\n assigned to this profile. Available in API version 31.0 and\n later.
customSettingAccesses\nProfileCustomSettingAccesses[]Indicates the custom settings that are read-accessible to a user\n assigned to this profile. Available in API version 47.0 and\n later.
descriptionstringThe profile description. Limit: 255 characters. Available in API\n version 30.0 and later.
externalDataSourceAccesses\nProfileExternalDataSourceAccess[]Indicates which data sources with identity type of Per\n User are available to users assigned to this profile.\n Available in API version\n 27.0 and later.\n
fieldLevelSecurities\nProfileFieldLevelSecurity[]Indicates which fields are visible to a user assigned to this\n profile, and the kind of access available (editable or hidden). This\n field is available in API version 22.0 and earlier.
fieldPermissions\nProfileFieldLevelSecurity[]Indicates which fields are visible to a user assigned to this\n profile, and the kind of access available (editable or readable).\n This field is available in API version 23.0 and later.
flowAccesses\nProfileFlowAccess[]Indicates which flows can be accessed by a user assigned to this\n profile. Available in API version 47.0 and later.
fullNamestringThe\n name can only contain characters, letters, and the underscore\n (_) character. The name must start with a letter, and can’t end\n with an underscore or contain two consecutive underscore\n characters.

Inherited from the Metadata component, this\n field isn’t defined in the WSDL for this component. It must be\n specified when creating, updating, or deleting. See create() to see\n an example of this field specified for a call.

\n
layoutAssignments\nProfileLayoutAssignments[]Indicates which layout to use for this profile.
loginFlows\nLoginFlow[]Indicates a business process that you direct users to before they\n access Salesforce.
loginHours\nProfileLoginHours[]\nIndicates the hours within which a\n user with this profile can log in. If not specified, the profile\n doesn’t restrict a user’s login hours.

This field is\n available in API version 25.0 and later.

\n
loginIpRanges\nProfileLoginIpRange[]\nThe list of IP address\n ranges from which users with a particular profile can log\n in.

This field is available in API version 17.0 and\n later.

\n
objectPermissions\nProfileObjectPermissions[]\nIndicates which objects are\n accessible to a user assigned to this profile, and the kind of\n access available (create, read, edit, delete, and so on). In API\n version 28.0 and later, this field is only retrieved when\n allowRead is true.\n

In\n API version 50.0 and later, editing standard objects on standard\n profiles is disabled.

\n
pageAccesses\nProfileApexPageAccess[]Indicates which Visualforce pages that users assigned to this\n profile can execute.
profileActionOverrides\nProfileActionOverride[]\nA list of the Lightning\n Experience Home page action overrides that are assigned to this\n profile. When a user logs in with a profile, a matching\n ProfileActionOverride assignment takes precedence over existing\n overrides for the Home tab specified in ActionOverride.

This field is available in API versions 37.0 to\n 44.0.

\n
recordTypeVisibilities\nProfileRecordTypeVisibility[]Indicates the visibility of record types for users assigned to\n this profile. In API version 29.0 and later, this field isn’t\n retrieved or deployed for inactive record types.
ServicePresenceStatusAccessesProfileServicePresenceStatusAccess[]Indicates which Service presence statuses that the user assigned\n to this profile can execute. Available in API version 64.0 and\n later.
tabVisibilities\nProfileTabVisibility[]Indicates which record types are visible to a user assigned to\n this profile, and therefore which tabs within an app are\n visible.
userLicensestring\nThe User\n License for the profile. A user license\n determines the baseline of features that the user can access.\n Every user must have exactly one user license.

This field\n is available in API version 17.0 and later.

\n
userPermissions\nProfileUserPermission[]Specifies a user permission (such as “API Enabled”)\n and whether it’s enabled for this profile. This field\n retrieves only enabled user permissions. Available in API version\n 29.0 and later.
\n\n
\n\n
\n

LoginFlow

\n\n \n

LoginFlow represents a business process that you direct users to\n before they access Salesforce. You can use Metadata API to define existing flows as\n login flows and to edit login flow definitions. To delete login flow definitions,\n use the Login Flow\n page.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
flowstringRequired only if the uiLoginFlowType is\n VisualWorkflow. The\n fullName of the Flow.

Before you can\n deploy the LoginFlow, the Flow referenced here must be deployed\n in your org and its status must be Active.

\n
flowtypeLoginFlowType (enumeration of type string)Required. The value is UI.
friendlynamestringRequired. The name of the LoginFlow.
uiLoginFlowTypeUiLoginFlowType (enumeration of type string)Required. The type of login flow. These are valid values.
    \n
  • \nVisualWorkflow—Indicates\n a Salesforce Flow. You can\n create these flows using Flow Builder.
    • \n\n
  • \nVisualForce—Indicates a\n flow created using Visualforce.
    • \n\n
\n
useLightningRuntimebooleanIndicates if Lightning Runtime is used (true) or not (false\n (default)). Used only if uiLoginFlowType is\n VisualWorkflow.
vfFlowPagestringRequired only if the uiLoginFlowType is\n VisualForce. The name of the\n VisualForce page.
vfFlowPageTitlestringRequired only if the uiLoginFlowType is\n VisualForce. The name of the\n VisualForce page.
\n\n
\n\n
\n

ProfileActionOverride

\n\n \n

ProfileActionOverride represents a user\n profile-based override of an ActionOverride on a standard Home \n tab in Lightning Experience.

\n
\n\"Note\"
\n

Note

\n

\n

    \n
  • ProfileActionOverride can be defined only on Profile for API version\n 39.0 to 44.0. In API version 45.0 and later, ProfileActionOverride must\n be defined for CustomApplication instead. Beginning with API version\n 45.0, Home page assignments related to user profile must also have a\n corresponding app assignment because more granular Home page assignments\n are supported. As a result, ProfileActionOverride is defined for\n CustomApplication rather than Profile.
    • \n\n
  • ProfileActionOverride settings aren’t retrieved in the\n .profile file unless a Lightning page is\n referenced in the package.xml file.
    • \n\n
\n\n

\n
\n
\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
actionNamestringRequired. The possible values are the same as the actions you can\n override:
    \n
  • accept
    • \n\n
  • clone
    • \n\n
  • delete
    • \n\n
  • edit
    • \n\n
  • list
    • \n\n
  • new
    • \n\n
  • tab
    • \n\n
  • view
    • \n\n
\n
contentstringSet this field if\n type is set to flexipage, lightningcomponent, scontrol, or visualforce. It refers to the\n name of the Lightning page, Lightning component, s-control, or\n Visualforce page to use as the override. To reference installed\n components, use this format: Component_namespace__Component_name.
formFactorFormFactor (enumeration of type string)The size of the page\n being overridden.

The Large value represents the\n Lightning Experience desktop environment and is valid only for\n the flexipage and lightningcomponent types. The\n Small value represents\n the Salesforce mobile app on a phone or tablet. The Medium value is reserved for\n future use. The null value\n (which is the same as specifying no value) represents Salesforce\n Classic.

\n
pageOrSobjectTypestringThe name of the\n sObject type being overridden. Valid values are standard and custom.

This value must be standard-home when actionName is tab.

\n
recordTypestringThe record type assigned to the ProfileActionOverride. If the\n PageOrSobjectType is standard-home, this field is\n null.
typeActionOverrideType (enumeration of type string)Required. Represents the type of action override. Valid values\n are described in ActionOverrideType.
\n\n
\n\n
\n

ProfileAgentAccess

\n\n \n

ProfileAgentAccess represents the agent access configuration for users assigned\n through a profile.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
agentNamestringRequired. The name of the employee agent.
enabledbooleanRequired. Indicates whether users assigned to this profile can\n use the Agentforce Employee Agent (true) or not (false).
\n\n
\n\n
\n

ProfileApplicationVisibility

\n\n \n

ProfileApplicationVisibility determines whether an app is visible\n to a user assigned to this profile.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
applicationstringRequired. The name of the app.
defaultbooleanRequired. Indicates whether the app is the default app (true) or not (false). Only one app per profile can\n be set to true.
visiblebooleanRequired. Indicates whether this app is visible to users assigned\n to this profile (true) or not\n (false).
\n\n
\n\n
\n

ProfileCategoryGroupVisibility

\n\n \n

ProfileCategoryGroupVisibility determines whether a data category group is visible to\n a user assigned to this profile. Available in API version 41.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
dataCategoriesstring[]Array of one or more data category names.
dataCategoryGroupstringRequired. The name of the data category group.
visibilityCategoryGroupVisibility (enumeration of type string)Required. Indicates the visibility of the data category. Valid\n values are:
    \n
  • ALL
    • \n\n
  • CUSTOM
    • \n\n
  • NONE
    • \n\n
\n
\n\n
\n\n
\n

ProfileCustomMetadataTypeAccess

\n\n \n

ProfileCustomMetadataTypeAccess represents the custom metadata type access for users assigned to a profile.\n Available in API version 47.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
FieldField TypeDescription
enabledbooleanRequired. Indicates whether the records for this custom metadata\n type are readable (true) or not\n (false).
namestringRequired. The custom metadata type name.
\n\n
\n\n
\n

ProfileApexClassAccess

\n\n \n

ProfileApexClassAccess determines which top-level Apex classes have methods that\n users assigned to this profile can execute.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
apexClassstringRequired. The Apex class name.
enabledbooleanRequired. Indicates whether users assigned to this profile can\n execute methods in the top-level class (true) or not (false).
\n\n
\n\n
\n

ProfileCustomPermissions

\n\n \n

ProfileCustomPermissions represents the custom permissions access for users assigned\n to a profile. Only enabled custom permissions are retrieved.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
enabledbooleanRequired. Indicates whether the custom permission is enabled\n (true) or not (false).
namestringRequired. The custom permission name.
\n\n
\n\n
\n

ProfileCustomSettingAccesses

\n\n \n

ProfileCustomSettingAccesses represents the custom setting access for users assigned\n to a profile. Available in API version 47.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
FieldField TypeDescription
enabledbooleanRequired. Indicates whether the records for this custom setting\n are readable (true) or not\n (false).
namestringRequired. The custom setting name.
\n\n
\n\n
\n

ProfileExternalDataSourceAccess

\n\n \n

ProfileExternalDataSourceAccess represents the data source access for users with\n identity type of Per User. Available in API version\n 27.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
enabledbooleanRequired. Indicates whether the data source is enabled (true) or not (false).
externalDataSourcestringThe name of the external data source.
\n\n
\n\n
\n

ProfileFieldLevelSecurity

\n\n \n

ProfileFieldLevelSecurity represents the field level security for\n users assigned to a profile. In API version 30.0 and later, permissions for required\n fields can’t be retrieved or deployed.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
editablebooleanRequired. Indicates whether this field is editable (true) or not (false).

In API version 30.0 and\n later, when deploying a new custom field, this field is false by default.

\n
fieldstringRequired. Indicates the name of the field.

When referencing\n shared Activity fields, specify Event or Task. For example,\n Event.Meeting__c.

\n
hiddenbooleanIndicates whether this field is hidden (true) or not (false). This field is available in API version 22.0 and\n earlier.

For portal profiles, this field is set to true by default in API version\n 19.0 and later.

\n
readablebooleanIndicates whether this field is readable (true) or not (false). This field is available in\n API version 23.0 and later. It replaces the\n hidden field.

In API version 30.0 and\n later, when deploying a new custom field, this field is false by default.

\n

For\n portal profiles, this field is set to false by default.

\n
\n\n
\n\n
\n

ProfileFlowAccess

\n\n \n

ProfileFlowAccess represents\n which flows a profile grants access to. Available in API version 47.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
FieldField TypeDescription
enabledbooleanRequired. Indicates whether users assigned this profile can\n access the flow (true) or not\n (false). The default value is\n false.
flowstringRequired. The name of the flow to which access is\n granted.
\n\n
\n\n
\n

ProfileLayoutAssignments

\n\n \n

ProfileLayoutAssignments determines which layout to use for a\n profile and a given entity.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
layoutstringRequired. Indicates the layout for this particular\n entity.
recordTypestringThis field is optional. If the recordType of\n the record matches a layout assignment rule, it uses the specified layout.\n
\n\n
\n\n
\n

ProfileLoginHours

\n\n \n

ProfileLoginHours restricts the days and times within which\n users with a particular profile can log in.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
weekdayStartstringSpecifies the earliest time on that day that a user with this\n profile can log in. If a start time for a particular day is\n specified, an end time for that day also must be specified. Start\n can’t be greater than end for a particular day.
    \n
  • Valid values for weekday:\n monday,\n tuesday,\n wednesday,\n thursday,\n friday,\n saturday, or\n sunday. For example,\n mondayStart indicates the beginning\n of the login period for Monday.
    • \n\n
  • Valid values for Start: the number of minutes since\n midnight. Must be evenly divisible by 60 (full hours). For\n example, 300 is 5:00\n AM.
    • \n\n
\n
weekdayEndstringSpecifies the time on that day that a user with this profile must\n log out by.
    \n
  • Valid values for weekday:\n monday,\n tuesday,\n wednesday,\n thursday,\n friday,\n saturday, or\n sunday. For example,\n mondayEnd indicates the close of\n the login period for Monday.
    • \n\n
  • Valid values for End: the number of minutes since midnight.\n Must be evenly divisible by 60 (full hours). For example,\n 1020 is 5:00\n PM.
    • \n\n
\n
\n\n

To delete login hour restrictions from a profile that previously had them, you must\n explicitly include an empty loginHours tag without any start or end times.

\n\n
\n\n
\n

ProfileLoginIpRange

\n\n \n

ProfileLoginIpRange IP defines an IP address range that users with a particular\n profile can log in from.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
descriptionstringUse this field to identify the purpose of the range, such as\n which part of a network corresponds to this range. This field is\n available in API version 31.0 and later.
endAddressstringRequired. The end IP address for the range.
startAddressstringRequired. The start IP address for the range.
\n\n
\n\n
\n

ProfileObjectPermissions

\n\n \n

ProfileObjectPermissions represents a user's access to\n objects.

\n\n
\n\"Note\"
\n

Note

\n

\n

    \n
  • In API version 18.0 and later, these permissions are disabled in new custom\n objects for any profiles where “View All Data” or “Modify All Data” is\n disabled.
    • \n\n
  • In API version 50.0 and later, editing standard objects on standard profiles\n is disabled.
    • \n\n
\n\n

\n
\n
\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
allowCreatebooleanIndicates whether the object referenced by the\n object field can be created by the users\n assigned to this profile (true)\n or not (false).

This field is named\n revokeCreate before version 14.0 and\n the logic is reversed. The field\n name change and the update from true to false and the reverse is automatically handled\n between versions and doesn’t require any manual editing of\n existing XML component files.\n

\n
allowDeletebooleanIndicates whether the object referenced by the\n object field can be deleted by the users\n assigned to this profile (true)\n or not (false).

This field is named\n revokeDelete before version 14.0 and\n the logic is reversed. The field\n name change and the update from true to false and the reverse is automatically handled\n between versions and doesn’t require any manual editing of\n existing XML component files.

\n
allowEditbooleanIndicates whether the object referenced by the\n object field can be edited by the users\n assigned to this profile (true)\n or not (false).

This field is named\n revokeEdit before version 14.0 and the\n logic is reversed. The field\n name change and the update from true to false and the reverse is automatically handled\n between versions and doesn’t require any manual editing of\n existing XML component files.

\n
allowReadbooleanIndicates whether the object referenced by the\n object field can be seen by the users\n assigned to this profile (true)\n or not (false).

This field is named\n revokeRead before version 14.0 and the\n logic is reversed. The field\n name change and the update from true to false and the reverse is automatically handled\n between versions and doesn’t require any manual editing of\n existing XML component files.

\n
modifyAllRecordsbooleanIndicates whether all records for the object referenced by the\n object field can be read, edited, or\n deleted by the users assigned to this profile (true) or not (false), regardless of the sharing\n settings for the object. This setting is equivalent to the Modify\n All Data user permission limited to the individual object level.\n Available in API version 15.0 and later.

This field isn’t\n available for all objects. Refer to the profile in the user\n interface to determine which objects currently support these\n permissions. Profiles with Modify All Data ignore\n modifyAllRecords entries in Metadata\n API and don't return an error if Modify All Data is enabled on\n the profile.

\n
objectstringRequired. The name of the object whose permissions are altered by\n this profile, for example, MyCustomObject__c.
viewAllFieldsbooleanIndicates whether all fields and field data for the object\n referenced by the object field can be read by\n the users assigned to this profile (true) or not (false). Available in API version 63.0 and later.
viewAllRecordsbooleanIndicates whether all records for the object referenced by the\n object field can be read by the users\n assigned to this profile (true)\n or not (false), regardless of the\n sharing settings for the object. This setting includes private\n records (records with no parent object). This setting is equivalent\n to the View All Data user permission limited to the individual\n object level. Available in API version 15.0 and later.

This field\n isn’t available for all objects. Refer to the profile in the\n user interface to determine which objects currently support\n these permissions. Profiles with \"View All Data\" ignore\n viewAllRecords entries in the Metadata\n API and don't return an error if View All Data is enabled on the\n profile.

\n
\n\n
\n\n
\n

ProfileApexPageAccess

\n\n \n

ProfileApexPageAccess determines which Visualforce pages that users assigned to this\n profile can execute.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
apexPagestringRequired. The Visualforce page name.
enabledbooleanRequired. Indicates whether users assigned to this profile can\n execute the Visualforce page (true) or not (false).
\n\n
\n\n
\n

ProfileRecordTypeVisibility

\n\n \n

ProfileRecordTypeVisibility represents the visibility of record types for this\n profile. Record types let you offer different business processes, picklist values,\n and page layouts to different users.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
defaultbooleanRequired. Indicates whether the record type is the default when\n users with this profile create records for this object (true) or not (false).
personAccountDefaultboolean\nWhen Person Accounts is\n enabled, this field indicates whether the record type is this\n profile’s default person account record type (true) or not (false). When Person Accounts is\n disabled, this field’s value has no impact.

Person\n accounts aren’t enabled by default in Salesforce. To request\n person accounts, contact Salesforce.

\n
recordTypestringRequired. The record type name, for example Account.MyRecordType.
visiblebooleanRequired. Indicates whether this record type is visible to users\n assigned to this profile (true)\n or not (false).
\n\n
\n\n
\n

ProfileTabVisibility

\n\n \n

ProfileTabVisibility represents the visibility of tabs for this\n profile. For version 17.0 and later, ProfileTabVisibility supports visibility of\n tabs for standard objects. The manifest file must include the standard object\n corresponding to a standard tab to retrieve the tab visibility in a profile.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
Field NameField TypeDescription
tabstringRequired. The name of the tab.
visibilityTabVisibility (enumeration of type string)Required. Indicates the visibility of the tab. Valid values are:
    \n
  • \nDefaultOff—The\n tab is available on the All Tabs page. Users can\n individually customize their display to make the tab visible\n in any app.
    • \n\n
  • \nDefaultOn—The\n tab is available on the All Tabs page and appears in the\n visible tabs for its associated app. Users can individually\n customize their display to hide the tab or make it visible\n in other apps.
    • \n\n
  • \nHidden—The tab\n isn’t available on the All Tabs page or visible in any\n apps.
    • \n\n
\n\n

In API version 36.0 and earlier, Hidden is returned only if visibility \n was set using the API. If it was set to Hidden from the profile in Salesforce, the API doesn’t return \n a visibility value. For version 37.0 and later, when tab visibility is set to\n hidden, the API returns Hidden, \n regardless of how the value was set.

\n
\n\n
\n\n
\n

ProfileUserPermission

\n\n \n

ProfileUserPermission represents an app or system permission for a profile. Use one\n of these elements for each permission.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
FieldField TypeDescription
enabledbooleanRequired. Indicates whether the permission is enabled (true) or disabled (false).
namestringRequired. The permission name.
\n\n
\n\n
\n

ProfileServicePresenceStatusAccess

\n\n \n

Represents the presence statuses that reps assigned to this profile have access.\n Available in API version 64.0 and later.

\n\n \n
\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n \n\n
FieldField TypeDescription
servicePresenceStatusstringRequired. The name of Service Presence Status.
enabledbooleanRequired. Indicates whether the rep assigned to this profile has\n access to the presence status (true) or not (false).
\n\n
\n\n
\n

Java Sample

\n\n \n

This sample uses picklists, profiles, record types, and a custom app:

\n\n 
public void profileSample() {\n  try {\n    // Create an expense report record, tab and app...\n    CustomObject expenseRecord = new CustomObject();\n    expenseRecord.setFullName(\"ExpenseReport__c\");\n    expenseRecord.setLabel(\"Expense Report\");\n    expenseRecord.setPluralLabel(\"Expense Reports\");\n    \n    expenseRecord.setDeploymentStatus(DeploymentStatus.Deployed);\n    expenseRecord.setSharingModel(SharingModel.ReadWrite);\n    \n    CustomField nameField = new CustomField();\n    nameField.setType(FieldType.AutoNumber);\n    nameField.setLabel(\"Expense Report Number\");\n    nameField.setDisplayFormat(\"ER-{0000}\");\n    expenseRecord.setNameField(nameField);\n    \n    AsyncResult[] arsExpenseRecord =\n        metadataConnection.create(new Metadata[] {expenseRecord});\n    \n    Picklist expenseStatus = new Picklist();\n    PicklistValue unsubmitted = new PicklistValue();\n    unsubmitted.setFullName(\"Unsubmitted\");\n    PicklistValue submitted = new PicklistValue();\n    submitted.setFullName(\"Submitted\");\n    PicklistValue approved = new PicklistValue();\n    approved.setFullName(\"Approved\");\n    PicklistValue rejected = new PicklistValue();\n    rejected.setFullName(\"Rejected\");\n    expenseStatus.setPicklistValues(new PicklistValue[] {\n        unsubmitted, submitted, approved, rejected}\n    );\n    \n    CustomField expenseStatusField = new CustomField();\n    expenseStatusField.setFullName(\n        \"ExpenseReport__c.ExpenseStatus__c\"\n    );\n    expenseStatusField.setLabel(\"Expense Report Status\");\n    expenseStatusField.setType(FieldType.Picklist);\n    expenseStatusField.setPicklist(expenseStatus);\n    AsyncResult[] arsStatusField =\n        metadataConnection.create(new Metadata[] \n            {expenseStatusField});\n    \n    CustomTab expenseTab = new CustomTab();\n    expenseTab.setFullName(\"ExpenseReport__c\");\n    expenseTab.setMotif(\"Custom70: Handsaw\");\n    expenseTab.setCustomObject(true);\n    AsyncResult[] arsTab =\n        metadataConnection.create(new Metadata[] {expenseTab});\n    \n    CustomApplication application = new CustomApplication();\n    application.setFullName(\"ExpenseForce\");\n    application.setTab(new String[] {expenseTab.getFullName()});\n    AsyncResult[] arsApp =\n        metadataConnection.create(new Metadata[] {application});\n    \n    // Employees and managers have the same app visibility...\n    ProfileApplicationVisibility appVisibility =\n        new ProfileApplicationVisibility();\n    appVisibility.setApplication(\"ExpenseForce\");\n    appVisibility.setVisible(true);\n    \n    Profile employee = new Profile(); \n    employee.setFullName(\"Employee\");\n    employee.setApplicationVisibilities(\n        new ProfileApplicationVisibility[] {appVisibility}\n    );\n    AsyncResult[] arsProfileEmp =\n    metadataConnection.create(new Metadata[] {employee});\n    \n    Profile manager = new Profile();\n    manager.setFullName(\"Manager\");\n    manager.setApplicationVisibilities(\n        new ProfileApplicationVisibility[] {appVisibility}\n    );\n    AsyncResult[] arsProfileMgr =\n        metadataConnection.create(new Metadata[] {manager});\n    \n    // But employees and managers have different access\n    // to the state of the expense sheet\n    RecordType edit = new RecordType();\n    edit.setFullName(\"ExpenseReport__c.Edit\");\n    RecordTypePicklistValue editStatuses =\n        new RecordTypePicklistValue();\n    editStatuses.setPicklist(\"ExpenseStatus__c\");\n    editStatuses.setValues(new PicklistValue[] \n        {unsubmitted, submitted});\n    edit.setPicklistValues(new RecordTypePicklistValue[] \n        {editStatuses});\n    AsyncResult[] arsRecTypeEdit =\n        metadataConnection.create(new Metadata[] {edit});\n    \n    RecordType approve = new RecordType();\n    approve.setFullName(\"ExpenseReport__c.Approve\");\n    RecordTypePicklistValue approveStatuses =\n        new RecordTypePicklistValue();\n    approveStatuses.setPicklist(\"ExpenseStatus__c\");\n    approveStatuses.setValues(new PicklistValue[] \n        {approved, rejected});\n    approve.setPicklistValues(new RecordTypePicklistValue[]\n        {approveStatuses});\n    AsyncResult[] arsRecTypeApp =\n        metadataConnection.create(new Metadata[] {approve});\n  } catch (ConnectionException ce) {\n    ce.printStackTrace();\n  }\n}
\n\n
\n\n \n\n
\n

Usage

\n

To create custom profiles, we recommend that you use the\n Profile object instead of the deploy() call on\n the Profile Metadata type. The Profile object allows you to create empty profiles\n that start without any permissions enabled except for required permissions for the\n profile’s user license.

\n

When you use the retrieve() call to get information about\n profiles, the returned .profile files only include security\n settings for the other metadata types referenced in the retrieve request. Exceptions\n include user permissions, IP address ranges, and login hours, which are always\n retrieved. For example, the following package.xml file contains\n a types element that matches all custom\n objects. The returned profiles contain object and field permissions for all custom\n objects in your organization but don’t include permissions for standard objects,\n such as Account, and standard\n fields.

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Package xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <types>\n        <members>*</members>\n        <name>CustomObject</name>\n    </types>\n   <types>\n        <members>*</members>\n        <name>Profile</name>\n    </types>\n    <version>65.0</version>\n</Package>
\n

The wildcard “*” on CustomObject doesn’t\n match standard objects. This wildcard behavior helps you to avoid making unintended,\n high-impact profile changes. If you create a few custom objects in a Developer\n Edition organization, retrieve() the information, and\n later deploy() the custom objects to your\n production org, the profile and field-level security for all your standard objects\n and fields aren’t overwritten. You can only overwrite these standard objects and\n fields by explicitly creating separate types\n elements for the objects or fields.

\n

Metadata API intentionally makes it\n difficult to include standard fields in retrieve() calls\n to prevent unexpected profile changes. But you can still retrieve and deploy profile\n permissions for custom and standard fields in standard objects, such as\n Account.

\n

This package.xml file allows you to return\n profile permissions for Account standard and custom fields. Note how the standard\n Account object is defined in a types element by\n specifying it as a member of a CustomObject\n type.

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Package xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <types>\n        <members>Account</members>\n        <name>CustomObject</name>\n    </types>\n   <types>\n        <members>*</members>\n        <name>Profile</name>\n    </types>\n    <version>65.0</version>\n</Package>
\n

This package.xml file allows you to\n return profile permissions for the MyCustomField__c custom field in the Account\n object.

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Package xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n   <types>\n        <members>Account.MyCustomField__c</members>\n        <name>CustomField</name>\n   </types>\n   <types>\n        <members>*</members>\n        <name>Profile</name>\n   </types>\n   <version>65.0</version>\n</Package>
\n

To retrieve field permissions for relationship fields,\n remove the “Id” part of the field. For example, in this\n package.xml file, to retrieve field permissions for the\n AccountId field for Contacts, you reference this field as\n Contact.Account not Contact.AcccountId.\n

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Package xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n   <types>\n        <members>Contact.Account</members>\n        <name>CustomField</name>\n   </types>\n   <types>\n        <members>*</members>\n        <name>Profile</name>\n   </types>\n   <version>65.0</version>\n</Package>
\n
\n\n
\n

Wildcard Support in the Manifest File

\n\n \n

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest\n file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}