---
schema_version: "1"
id: 21d87f2b0e1edb65580b56390f9765606863fba1bc00ac4f8abe3cf88a4306a2
title: PermissionSet
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_permissionset.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_permissionset.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: e9774cf6685bc4958e81c9e6f3c27a95f2570071587cc9deab44e4c6b0f2e493
description: Represents a set of permissions that’s used to grant more access to users without changing their profile or reassigning profiles. Available in API version 28.0 and later.
---
# PermissionSet

Represents a set of permissions that’s used to grant more access to users without changing their profile or reassigning profiles. Available in API version 28.0 and later.

## Supported SOAP Calls

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

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

To view the following settings, assignments, and permissions for standard and custom objects in a specified permission set, the View Setup and Configuration permission is required.

- Client settings
- Field permissions
- Layout assignments
- Object permissions
- Permission dependencies
- Permission set tab settings
- Permission set group components
- Record types

## Fields

| Field Name | Details |
| --- | --- |
| Description | 
Type

string

Properties

Filter, Nillable, Group, Sort

Description

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



 |
| HasActivationRequired | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

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



 |
| IsCustom | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

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.



 |
| IsOwnedByProfile | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

If true, the permission set is owned by a profile. Available in API version 25.0 and later.



 |
| Label | 

Type

string

Properties

Filter, Group, Sort

Description

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



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





 |
| Name | 

Type

string

Properties

Filter, Group, Sort

Description

The permission set group name.



 |
| NamespacePrefix | 

Type

string

Properties

Filter, Group, Nillable, Sort

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

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

Properties

Filter, Group, Nillable, Sort

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. Available in API version 45.0 and later.



 |
| ProfileId | 

Type

reference

Properties

Filter, Group, Nillable, Sort

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.



 |
| Type | 

Type

picklist

Properties

Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

Description

The permission set type.



 |