MutingPermissionSet

Represents a set of disabled permissions and is used in conjunction with PermissionSetGroup.

Parent Type 

This type extends PermissionSet and inherits its fields.

File Suffix and Directory Location 

Muting permission sets are stored in the mutingpermissionsets directory. The file name matches the muting permission set API name and the extension is .mutingpermissionset. For example, a mutingpermissionsets with the name Finance_Mgmt_MutingPermSet is stored in mutingpermissionsets/Finance_Mgmt_MutingPermSet.mutingpermissionset.

Version 

This object is available in API version 46.0 and later.

Special Access Rules 

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 muting 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

Fields 

label 

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

Declarative Metadata Sample Definition 

The following example deploys a MutingPermissionSet used in a Permission Set Group intended for users submitting job applications for a custom application. The muting permission set has administrative permissions enabled to ensure that they’re muted in the Permission Set Group.

1<?xml version="1.0" encoding="UTF-8"?>
2<MutingPermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Job Apps User Muted</label>
4    <description>Mutes any administrative tasks for the Job Apps user</description>
5    <hasActivationRequired>false</hasActivationRequired>
6    <license>Salesforce</license>
7    <applicationVisibilities>
8        <application>JobApps__Approval</application>
9        <visible>true</visible>
10    </applicationVisibilities>
11    <classAccesses>
12        <apexClass>ApprovalUtility</apexClass>
13        <enabled>true</enabled>
14    </classAccesses>
15    <customPermissions>
16        <enabled>true</enabled>
17        <name>JobAppApprover</name>
18    </customPermissions>
19    <fieldPermissions>
20        <editable>false</editable>
21        <field>Job_Request__c.Salary__c</field>
22        <readable>true</readable>
23    </fieldPermissions>
24    <objectPermissions>
25        <allowCreate>true</allowCreate>
26        <allowDelete>true</allowDelete>
27        <allowEdit>true</allowEdit>
28        <allowRead>true</allowRead>
29        <customizeSetup>true</customizeSetup>
30        <deleteSetup>true</deleteSetup>
31        <modifyAllRecords>true</modifyAllRecords>
32        <object>Approval_Confirmation__c</object>
33        <viewAllRecords>true</viewAllRecords>
34        <viewSetup>true</viewSetup>
35    </objectPermissions>
36    <pageAccesses>
37        <apexPage>Job_Approval_Web_Form</apexPage>
38        <enabled>true</enabled>
39    </pageAccesses>
40    <recordTypeVisibilities>
41        <recordType>Approval_Confirmation__c.DevManager</recordType>
42        <visible>true</visible>
43    </recordTypeVisibilities>
44    <tabSettings>
45        <tab>Approval_Confirmation__c</tab>
46        <visibility>Visible</visibility>
47    </tabSettings>
48</MutingPermissionSet>

The following is an example package.xml manifest used to retrieve the MutingPermissionSet metadata for an organization.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Job_Apps_User</members>
5        <name>PermissionSetGroup</name>
6    </types>
7    <types>
8        <members>Job_Apps_User_Muted</members>
9        <name>MutingPermissionSet</name>
10    </types>
11    <version>49.0</version>
12</Package>

Wildcard Support in the Manifest File 

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.