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.

Introduced in API version 41.0.

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

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

• Type: textarea
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The Permission Set Group description.

• Type: string
• Properties: Create, Filter, Group, Sort, Update
• Description: The permission set group name used in the API.

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Introduced: API version 53.0
• Description: Indicates whether the permission set group requires an associated active session (true) or not (false). The default value is false.

• Type: picklist
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: The Permission Set Group language.
• Possible values:
  • da — da
  • de — de
  • en_US — en_US
  • es — es
  • es_MX — es_MX — Mexican)
  • fi — fi
  • fr — fr
  • it — it
  • ja — ja
  • ko — ko
  • nl_NL — nl_NL
  • no — no
  • pt_BR — pt_BR — Brazilian)
  • ru — ru
  • sv — sv
  • th — th
  • zh_CN — zh_CN — Simplified)
  • zh_TW — zh_TW — Traditional)

• Type: string
• Properties: Create, Filter, Group, Sort, Update
• Description: The permission set group label for the aggregated permissions.

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Description: The permission set group namespace prefix.

• Type: picklist
• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
• Description: Indicates permission set group recalculation status.
• Possible values:
  • Updated — Updated
  • Outdated — Outdated
  • Updating — Updating
  • Failed — Failed

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:

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