PermissionSet

Represents a set of permissions that’s used to grant more access to users without changing their profile or reassigning profiles.

Version 

Introduced in API version 37.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve(), search()

Supported REST API Methods 

GET, HEAD, Query

Special Access Rules 

• As of Summer ’20 and later, only users who have one of these permissions can access this object:

  • View Setup and Configuration

  • Manage Session Permission Set Activations

  • Assign Permission Sets

  • Manage Profiles and Permission Sets

  • Client settings

  • Field permissions

  • Layout assignments

  • Object permissions

  • Permission dependencies

  • Permission set tab settings

  • Permission set group components

  • Record types

Fields 

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A description of the permission set. Limit: 255 characters.

HasActivationRequired 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 37.0

• Description: Indicates whether the permission set requires an associated active session (true) or not (false).

• Default value: false

IsCustom 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 39.0

• Description: If true, the permission set is custom (created by an admin); if false, the permission set is standard and related to a specific permission set license.

• Default value: false

IsOwnedByProfile 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 25.0

• Description: If true, the permission set is owned by a profile.

• Default value: false

Label 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The permission set label, which corresponds to Label in the user interface. Limit: 80 characters.

LicenseId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 38.0

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Name 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The permission set group name.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 23.0

• Description: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.

In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

PermissionSetGroupId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 41.0

• Description: If the permission set is owned by a permission set group, this field returns the ID of the permission set group. If the permission set isn’t owned by a permission set group, this field returns a null value.

• Relationship name: PermissionSetGroup

• Relationship type: relationship

• Refers to: PermissionSetGroup

ProfileId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 25.0

• Description: If the permission set is owned by a profile, this field returns the ID of the profile. If the permission set isn’t owned by a profile, this field returns a null value.

• Relationship name: Profile

• Relationship type: relationship

• Refers to: Profile

PsgCount 

• Type: int
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 63.0

Type 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 46.0

• Description: The permission set type.

• Possible values:

  • Regular — Regular (default)

  • Profile — Profile

  • Group — Group

  • Session — Session

  • Integration — Integration

  • Standard — Standard

• Default value: Regular