PermissionSetGroup (Beta)

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. This object is available in API version 45.0 and later.

As a beta feature, PermissionSetGroup is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. You can provide feedback and suggestions for PermissionSetGroup in the Trailblazer Community.

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 (Beta) 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 (Beta)

Supported Calls

Fields

Usage