PermissionSetGroup (Pilot)

Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks and then package them. This object is available in API version 45.0 and later.

We provide this feature to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Because pilot programs are subject to change, we can’t guarantee acceptance. This pilot feature isn’t generally available, as referenced in this document or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available features.

Note

Supported Calls

create(), delete(), describeSObject(), query(), retrieve(), update(), upsert()

Fields

Field Name	Details
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The Permission Set Group description.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The permission set group name used in the API.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The Permission Set Group language. Possible values are: `da` (Danish) `de` (German) `en_US` (English) `es` (Spanish) `es_MX` (Spanish - Mexican) `fi` (Finnish) `fr` (French) `it` (Italian) `ja` (Japanese) `ko` (Korean) `nl_NL` (Dutch) `no` (Norwegian) `pt_BR` (Portuguese - Brazilian) `ru` (Russian) `sv` (Swedish) `th` (Thai) `zh_CN` (Chinese - Simplified) `zh_TW` (Chinese - Traditional)
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The permission set group label for the aggregated permissions.
NameSpacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The permission set group namespace prefix.
Status	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Indicates permission set group recalculation status. `Updated`. The group is current. `Outdated`. The group requires recalculation. `Updating`. The group is in recalculation mode. `Failed`. The group recalculation failed.

Usage

Use the PermissionSetGroup (Pilot) object to query existing permission set groups and to find which aggregated permissions are included in the group.

For example, to search for all object permissions in a permission set group named StandardAccountingUsers:

1SELECT SObjectType
2FROM ObjectPermissions
3WHERE Parent.PermissionSetGroup.DeveloperName = 'StandardAccountingUsers'

To create a permission set group using the REST API, you can submit a POST request.

1POST
2/services/data/v45.0/tooling/sobjects/PermissionSetGroup/
3
4{
5    "DeveloperName":"Sales", "MasterLabel": "sales_label"
6}

Object Reference for Salesforce and Lightning Platform

PermissionSetGroup (Pilot)

Supported Calls

Fields

Usage