{"id":"sforce_api_objects_permissionsetlicense","title":"PermissionSetLicense","content":"

PermissionSetLicense

\n
\nRepresents a license that’s used to enable one or more users to\n receive a specified permission without changing their profile or reassigning profiles. You can\n use permission set licenses to grant access, but not to deny access. This object is\n available in API version 29.0 and later.
\n\n
\n

Supported Calls

\n\n \n

describeLayout(), describeSObjects(), query(), retrieve()

\n\n
\n\n
\n

Special Access Rules

\n\n \n

As of Spring ’20 and later, only your Salesforce org's internal users can access this\n object.

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
Field NameDetails
DeveloperName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
\n

The unique name of the object in the API. This name can contain only\n underscores and alphanumeric characters, and must be unique in your org. It\n must begin with a letter, not include spaces, not end with an underscore,\n and not contain two consecutive\n underscores.

\n\n
\n\n \n \n
\n
\n\"Note\"
\n

Note

\n

When creating large sets of data, always specify a unique\n DeveloperName for each record. If no\n DeveloperName is specified, performance slows down\n while Salesforce generates one for each record.

\n
\n
\n\n
\n\n
\n
\n\"Note\"
\n

Note

\n

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

\n
\n
\n\n
\n\n \n
\n\n
ExpirationDate\n
\n \n
Type
\n\n
date
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The date at which the permission set license expires.
\n\n \n
\n\n
IsAvailableForIntegrations\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether the permission set license is enabled for integrations\n (true) or not (false). When this field is set to true, Salesforce integration features can\n access data. The default value is false.\n This field is read-only in the API and can be edited only in Setup.
\n\n
If integrations are required for feature functionality and the license isn't\n enabled for integrations, you receive an error when setting up the\n session-based permission set or executing the feature. Only enable\n integrations if necessary for the feature.
\n\n \n
\n\n
\nIsSupplementLicense (Developer Preview)\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates whether a custom permission set license is a supplement license\n (true) or a foundation license (false). The default value is false.
\n\n
This field is only available if the Partner Licensing Platform developer\n preview is enabled. This field is available in API version 55.0 and\n later.
\n\"Note\"
\n

Note

\n

The Partner Licensing Platform is available as a developer\n preview. The Partner Licensing Platform isn’t generally available unless or\n until Salesforce announces its general availability in documentation or in\n press releases or public statements. All commands, parameters, and other\n features are subject to change or deprecation at any time, with or without\n notice. Don't implement functionality developed with these commands or tools\n in your production package.

\n
\n
\n
\n\n \n
\n\n
Language\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
\n

The language of the permission set license.

\n\n
\n\n \n
\n\n
MasterLabel\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The label of the permission set license. Label is Permission Set\n License Label.
\n\n \n
\n\n
MaximumPermissionsPermissionName\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Filter
\n\n \n \n
Description
\n\n
One field for each permission. For example,\n MaximumPermissionsIdentityConnect corresponds to the\n “Use Identity Connect” permission.

If\n true, this PermissionSetLicense grants the\n specified permission. The number of fields varies depending on the\n permissions available for the organization.

\n
\n\n \n
\n\n
PermissionSetLicenseKey\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, idLookup, Sort
\n\n \n \n
Description
\n\n
A string that uniquely identifies a particular permission set license.
\n\n \n
\n\n
Status\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
The status of a permission set license. If Active, the\n permission set license is available. If Disabled, the\n permission set license has expired.
\n\n \n
\n\n
TotalLicenses\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The total number of this permission set license that are available to your\n organization.
\n\n \n
\n\n
UsedLicenses\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Sort
\n\n \n \n
Description
\n\n
The number of this permission set license that are currently assigned to\n users.
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

Users with the “View Setup and Configuration” permission can use the\n PermissionSetLicense object to view the set of currently defined permission set licenses in\n your organization.

\n\n

Use the PermissionSetLicense object to query existing permission licenses.

\n\n
For example, to return a list of all active permission set\n licenses:
SELECT MasterLabel \nFROM PermissionSetLicense\nWHERE Status = 'Active'
\nWhen combined with the PermissionSetLicenseAssign object,\n you can create a nested query that returns all users assigned to a particular permission set\n license like “Identity\n Connect”:
SELECT MasterLabel, (SELECT AssigneeId FROM PermissionSetLicenseAssign) \nFROM PermissionSetLicense \nWHERE MaximumPermissionsIdentityConnect=true
\n
\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}