---
schema_version: "1"
id: 0673bd6ad8d9da632f1306aab003ac5f72848ba979e08a0f20c1a54ab623585e
title: PermissionSetGroup
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_permissionsetgroup.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_permissionsetgroup.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 151b6fb28e607b6d9e14ae4e054e29d86e1ebf42fef98465c058e6f7b9e5d260
description: 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.
---
# PermissionSetGroup

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.

## Supported Calls

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

## Special Access Rules

As of Summer ’20 and later, to view this object, users must have one of these permissions:

- View Setup and Configuration
- Manage Session Permission Set Activations
- Assign Permission Sets

To edit this object, users must have the Manage Profiles and Permission Sets permission.

## 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.



 |
| HasActivationRequired | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

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.



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

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

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

POST
/services/data/v45.0/tooling/sobjects/PermissionSetGroup/

{
    "DeveloperName":"Sales", "MasterLabel": "sales\_label"
}