PermissionSet

Represents a set of permissions that’s used to grant more access to one or more users without changing their profile or reassigning profiles. You can use permission sets to grant access but not to deny access.

In API version 40.0 and later, when you retrieve permission set metadata, all content exposed in Metadata API for the permission sets is included. The metadata includes Apex associated with the permission set, CRUD, and so on. Likewise, when you deploy a permission set, you must include all of its metadata to avoid accidentally overwriting the permission set’s contents.

In API version 39.0 and earlier, retrieving or deploying permission set metadata returns only app and system permissions assigned to the permission set. Junction metadata (such as Apex, CRUD) are included only if the metadata for the related component is also included in the package definition.

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

For more information, see the Managed Component Access section of Sample package.xml Manifest Files in the Metadata API Developer Guide.

This type extends Metadata and inherits its fields.

Permission sets are stored in the permissionsets directory. The file name matches the permission set API name and the extension is .permissionset. For example, a permission set with the name User_Management_Perms is stored in permissionsets/User_Management_Perms.permissionset.

Permission sets are available in API version 22.0 and later.

As of Summer ’20 and later, only users who have one of these permissions can access this type:

• View Setup and Configuration
• Manage Session Permission Set Activations
• Assign Permission Sets
• Manage Profiles and Permission Sets

To view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required.

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

• Type: PermissionSetAgentAccess[]
• Required: No
• Introduced: API version 63.0
• Description: Indicates which agents are visible to users assigned to this permission set.

• Type: PermissionSetApplicationVisibility[]
• Required: No
• Introduced: API version 29.0
• Description: Indicates which apps are visible to users assigned to this permission set. In API version 29.0, this field supports custom apps only. In API version 30.0 and later, this field supports both standard and custom apps.

• Type: PermissionSetApexClassAccess[]
• Required: No
• Introduced: API version 23.0
• Description: Indicates which top-level Apex classes have methods that users assigned to this permission set can execute.

• Type: PermissionSetCustomMetadataTypeAccess[]
• Required: No
• Introduced: API version 47.0
• Description: Indicates the custom metadata types that are read-accessible to a user assigned to this permission set.

• Type: PermissionSetCustomPermissions[]
• Required: No
• Introduced: API version 31.0
• Description: Indicates which custom permissions are available to users assigned to this permission set.

• Type: PermissionSetCustomSettingAccess[]
• Required: No
• Introduced: API version 47.0
• Description: Indicates the custom settings that are read-accessible to a user assigned to this permission set.

• Type: string
• Required: No
• Description: The permission set description. Limit: 255 characters.

• Type: PermissionSetEmailRoutingAddressAccess[]
• Required: No
• Introduced: API version 62.0
• Description: Indicates the Email Routing Address permissions that are available to users assigned to a permission set.

• Type: PermissionSetExternalCredentialPrincipalAccess[]
• Required: No
• Introduced: API version 59.0
• Description: Indicates which external credential principals are available to users assigned to this permission set.

• Type: PermissionSetExternalDataSourceAccess[]
• Required: No
• Introduced: API version 27.0
• Description: Indicates which data sources with identity type of Per User are available to users assigned to this permission set.

• Type: PermissionSetFieldPermissions[]
• Required: No
• Introduced: API version 23.0
• Description: Indicates which fields are accessible to a user assigned to this permission set, and the kind of access available (readable or editable).

• Type: PermissionSetFlowAccess[]
• Required: No
• Introduced: API version 47.0
• Description: Indicates which flows can be accessed by a user assigned to this permission set.

• Type: PermissionSetGenComputingSummaryDefAccess[]
• Required: No
• Introduced: API version 66.0
• Description: Indicates the enhanced summary access configuration for users assigned through a permission set.

• Type: boolean
• Required: No
• Introduced: API version 37.0
• Description: Indicates whether the permission set requires an associated active session (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The permission set label. Limit: 80 characters.

• Type: string
• Required: No
• Introduced: API version 38.0
• Description: Either the related permission set license or the user license associated with this permission set. Use this field instead of userLicense, which is deprecated and only available up to API Version 37.0.

• Type: PermissionSetObjectPermissions[]
• Required: No
• Introduced: API version 23.0
• Description: Indicates the objects that are accessible to a user assigned to this permission set, and the kind of access available (create, read, edit, delete, and so on).

• Type: PermissionSetApexPageAccess[]
• Required: No
• Introduced: API version 23.0
• Description: Indicates which Visualforce pages that users assigned to this permission set can execute.

• Type: PermissionSetRecordTypeVisibility[]
• Required: No
• Introduced: API version 29.0
• Description: Indicates which record types are visible to users assigned to this permission set. This field is never retrieved or deployed for inactive record types.

• Type: PermissionSetServicePresenceStatusAccess[]
• Required: No
• Introduced: API version 64.0
• Description: Indicates which Service presence statuses that the user assigned to this profile can execute.

• Type: PermissionSetTabSetting[]
• Required: No
• Introduced: API version 26.0
• Description: Indicates the tab visibility settings for this permission set.

• Type: string
• Required: No
• Description: Deprecated. The user license for the permission set. A user license determines the baseline of features that the user can access. Every user must have exactly one user license. Available up to API version 37.0. In API version 38.0 and later, use license.

• Type: PermissionSetUserPermission[]
• Required: No
• Description: Specifies an app or system permission (such as “API Enabled”) and whether it’s enabled for this permission set. In API version 28.0 and earlier, this field retrieves all user permissions, enabled or disabled. In API version 29.0 and later, this field retrieves only enabled user permissions. In API Version 40.0 and later, if a permission isn’t specified for a deployment, it’s disabled.

PermissionSetAgentAccess represents the agent access configuration for users assigned through a permission set.

• Type: string
• Required: Yes
• Description: Required. The name of the employee agent.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether users assigned to this permission set can use the Agentforce Employee Agent (true) or not (false).

PermissionSetApexClassAccess represents the Apex class access for users assigned to a permission set.

• Type: string
• Required: Yes
• Description: Required. The Apex class name.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether users assigned to this permission set can execute methods in the top-level class (true) or not (false).

PermissionSetApexPageAccess represents the Visualforce page access for users assigned to a permission set.

• Type: string
• Required: Yes
• Description: Required. The Visualforce page name.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether users assigned to this permission set can execute the Visualforce page (true) or not (false).

PermissionSetApplicationVisibility determines whether an app is visible to a user assigned to this permission set.

• Type: string
• Required: Yes
• Description: Required. The app name.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether this app is visible to users assigned to this permission set (true) or not (false).

PermissionSetCustomMetadataTypeAccess represents the custom metadata type access for users assigned to a permission set.

Introduced in API version 47.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the records for this custom metadata type are readable (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The custom metadata type name.

PermissionSetCustomPermissions represents the custom permissions access for users assigned to a permission set. Only enabled custom permissions are retrieved.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the custom permission is enabled (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The custom permission name.

• Type: boolean
• Required: Yes

• Type: string
• Required: Yes

PermissionSetCustomSettingAccesses represents the custom setting access for users assigned to a permission set.

Introduced in API version 47.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the records for this custom setting are readable (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The custom setting name.

PermissionSetEmailRoutingAddressAccess represents the Email Routing Address access for users assigned to a permission set. Only enabled email routing addresses are retrieved.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the custom permission is enabled (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. Represents an organization’s Email-to-Case routing address.

PermissionSetExternalCredentialPrincipalAccess represents the access to the external credential’s principals. Users assigned to the permission set can make callouts using a named credential that references the external credential.

Introduced in API version 59.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether external credential principal access is enabled on the permission set (true) or not (false).

• Type: string

• Required: Yes

• Description: Required. The name of the external credential and principal, separated by a dash. For example, myExternalCredential-myPrincipal.

  If the external credential and principal are part of a package, include the package’s namespace prefix with the principal’s name using this format: namespacePrefix__myExternalCredential-myPrincipal. Use two underscores (__) between the namespace prefix and the external credential principal’s name.

PermissionSetExternalDataSourceAccess represents the data source access for users with identity type of Per User.

Introduced in API version 27.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the data source is enabled (true) or not (false).

• Type: string
• Required: Yes
• Description: The name of the external data source.

PermissionSetFieldPermissions represents the field permissions for users assigned to a permission set. In API version 30.0 and later, permissions for required fields can’t be retrieved or deployed. In API version 54.0 and later, only field permissions enabled in the permission set are returned in queries.

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

If the View All Fields object permission is enabled for an object in the permission set, the individual fields aren’t returned under fieldPermissions. However, if you later disable the View All Fields object permission, the fields are returned under fieldPermissions and you can remove access to the fields manually.

If the View All Fields object permission is enabled for an object in the permission set, the individual fields aren’t returned under fieldPermissions . However, if you later disable the View All Fields object permission, the fields are returned under fieldPermissions and you can remove access to the fields manually.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the field can be edited by the users assigned to this permission set (true) or not (false).

• Type: string

• Required: Yes

• Description: Required. The API name of the field (such as Warehouse__c.Description__c).

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

• Type: boolean
• Required: No
• Description: Indicates whether the field can be read by the users assigned to this permission set (true) or not (false).

PermissionSetFlowAccess represents which flows a permission set grants access to.

Introduced in API version 47.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether users assigned this permission set can access the flow (true) or not (false) The default value is false.

• Type: string
• Required: Yes
• Description: Required. The name of the flow to which access is granted.

PermissionSetGenComputingSummaryDefAccess represents the enhanced summary access configuration for users assigned through a permission set.

Introduced in API version 66.0.

• Type: string
• Required: Yes
• Description: Required. Indicates whether the users assigned to this profile can access the enhanced summary configuration (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the access configuration is enabled (true) or not (false).

PermissionSetObjectPermissions represents the object permissions for a permission set. Use one of these elements for each permission.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the object referenced by the object field can be created by the users assigned to this permission set (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the object referenced by the object field can be deleted by the users assigned to this permission set (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the object referenced by the object field can be edited by the users assigned to this permission set (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the object referenced by the object field can be viewed by the users assigned to this permission set (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether all records for the object referenced by the object field can be viewed, edited, or deleted by the users assigned to this permission set (true) or not (false), regardless of the sharing settings for the object. Includes private records (records with no parent object). Similar to the Modify All Data user permission, but limited to the individual object level.

• Type: string
• Required: Yes
• Description: Required. The API name of the object (such as Warehouse__c).

• Type: boolean
• Required: No
• Introduced: API version 63.0
• Description: Indicates whether all fields and field data for the object referenced by the object field can be viewed by the users assigned to this permission set (true) or not (false).

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether all records for the object referenced by the object field can be viewed by the users assigned to this permission set (true) or not (false), regardless of the sharing settings for the object. This setting includes private records (records with no parent object). The viewAllRecords field is similar to the View All Data user permission but limited to the individual object level.

PermissionSetRecordTypeVisibility represents the visibility of record types for this permission set.

• Type: string
• Required: Yes
• Description: Required. The record type name, for example Account.MyRecordType.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the record type is visible to users assigned to this permission set (true) or not (false).

Represents the presence statuses that reps assigned to this profile have access.

Introduced in API version 64.0.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the rep assigned to this profile has access to the presence status (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The name of Service Presence Status.

PermissionSetTabSetting represents the tab settings for a permission set.

• Type: string
• Required: Yes
• Description: Required. The tab name.

• Type: PermissionSetTabVisibility (enumeration of type string)
• Required: Yes
• Description: Required. Indicates the visibility settings for the tab.
• Possible values:
  • Available — The tab is available on the All Tabs page. Individual users can customize their display to make the tab visible in any app.
  • None — The tab isn’t available on the All Tabs page or visible in any apps.
  • Visible — The tab is available on the All Tabs page and appears in the visible tabs for its associated app. Individual users can customize their display to hide the tab or make it visible in other apps.

In API version 28.0 and earlier, PermissionSetUserPermission represents an app or system permission for a permission set. In API version 29.0 and later, this field retrieves only enabled user permissions. Use one of these elements for each permission.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the permission is enabled (true) or disabled (false).

• Type: string
• Required: Yes
• Description: Required. The name of the permission.

The following is an example of a PermissionSet component.

The following is an example package.xml manifest used to retrieve the PermissionSet metadata for an organization. When you retrieve permission sets, also retrieve the related components with assigned permissions. For example, to retrieve objectPermissions and fieldPermissions for a custom object, you must also retrieve the CustomObject component.

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