---
schema_version: "1"
id: 5252b28ebb61aefab124c14c65f012755705ca9f64f88cd41782308d97c7898f
title: PermissionSetGroup
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_permissionsetgroup.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_permissionsetgroup.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 49163167d6a95f2869b60bdbb01ddd769ac2affbfb45849e8b418a10a090bc80
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. Available in Tooling 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. Available in Tooling API version 45.0 and later.

## Supported SOAP Calls

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

## Supported REST HTTP Methods

Query, GET, POST, PATCH, DELETE

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

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png)

#### Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.















 |
| 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. 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) defaults 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
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged





 |
| 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 object to query existing permission set groups and to find which aggregated permissions are included in the group.