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. Then, you can package the groups as needed. Available in Tooling 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 SOAP Calls

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

Supported REST HTTP Methods

Query, GET, POST, PATCH, DELETE

Fields

Field Name	Details
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Query, Retrieve Update Description The permission set group description.
DeveloperName	Type string Properties Create, Filter, Group, NameField, Sort, Update Description The permission set group name used in the API.
IsDeleted	Type boolean Properties DefaultedOnCreate, Create, Filter, Group, Sort Description Indicates if the permission set group is deleted (true) or not (false).
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The Permission Set Group language. Valid values are: Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Spanish (Mexico) falls back to Spanish for customer-defined translations. Swedish: `sv` Thai: `th` The Salesforce user interface is fully translated to Thai, but Help is in English.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `installed` `released` `unmanaged` For more information about states of manageability for components in Salesforce AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.
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 string Properties DefaultedOnCreate, Filter, Group, Restricted picklist, Sort Description Indicates the 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.