PermissionSetGroup
This type extends the Metadata metadata type and inherits its fullName field.
Declarative Metadata File Suffix and Directory Location
Permission set groups are stored in the permissionsetgroups directory. The file name matches the permission set API name and the extension is .permissionsetgroup. For example, a permission set group with the name Finance_Mgmt_PermSetGroup is stored in permissionsetgroups/Finance_Mgmt_PermSetGroup.permissionsetgroup.
Version
Permission set groups are available in API version 45.0 and later.
Special Access Rules
As of Summer ’20 and later, to view this type, users must have one of these permissions:
- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets
To edit this type, users must have the Manage Profiles and Permission Sets permission.
Fields
Field | Field Type | Description |
---|---|---|
description | string | The permission set group description provided by the permission set group creator. |
hasActivationRequired | boolean | Indicates whether the permission set group requires an associated active session (true) or not (false). The default value is false. This field is available in API version 53.0 and later. |
label | string | Required. The permission set group label. |
mutingPermissionSets | string | A permission set containing permissions to disable in the permission set group. This field is available in API version 46.0 and later. |
permissionSets | string | A permission set or permission sets included in the permission set group. |
status | string | Indicates permission set group recalculation status. Valid values are:
|
Declarative Metadata Sample Definition
When adding a permission set group, you can do something like this. Individual permissions are included in the permission set referenced, not in the permission set group.
<?xml version="1.0" encoding="UTF-8"?>
<PermissionSetGroup xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>Finance_Mgmt_PermSetGroup</fullName>
<description>Finance_Mgmt_PermSetGroup desc</description>
<label>Finance_Mgmt_PermSetGroup</label>
<permissionSets>Billing_PS</permissionSets>
</PermissionSetGroup>
The permission set Billing_PS contains the individual permissions included in Finance_Mgmt_PermSetGroup.
<?xml version="1.0" encoding="UTF-8"?>
<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>Billing_PS</fullName>
<description>Billing_PS</description>
<label>Billing_PS</label>
<hasActivationRequired>false</hasActivationRequired>
<license>Salesforce</license>
<userPermissions>
<enabled>true</enabled>
<name>ViewSetup</name>
</userPermissions>
<userPermissions>
<enabled>true</enabled>
<name>ViewRoles</name>
</userPermissions>
<userPermissions>
<enabled>true</enabled>
<name>EditBillingInfo</name>
</userPermissions>
</PermissionSet>
This example package.xml manifest retrieves the PermissionSetGroup metadata for an org. When you retrieve permission set groups, also retrieve the related components. For example, to retrieve PermissionSetGroup, you must also retrieve PermissionSet.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Finance_Mgmt_PermSetGroup</members>
<name>PermissionSetGroup</name>
</types>
<types>
<members>Billing_PS</members>
<name>PermissionSet</name>
</types>
<version>45.0</version>
</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.