PermissionSetLicenseDefinition (Developer Preview) | Object Reference for the Salesforce Platform

Supported Calls

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

Special Access Rules

To access PermissionSetLicenseDefinition, you must have the Partner Licensing Platform developer preview enabled. To participate in this developer preview, submit a participation request via the Partner Licensing Platform Developer Preview Partner Community group.

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

Note

Fields

Field	Details
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
IsSupplementLicense	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the custom permission set license is a supplement license (`true`) or a foundation license (`false`). The default value is `false`. This field is available in API version 55.0 and later.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The two- to five-character code that represents the language and locale ISO. This code controls the language for labels displayed in an application.
LicenseExpirationPolicy	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The license expiration policy of the custom permission set license. Possible values are: `BlockNamespaceAccess`—Package access is blocked for existing users when all custom permission set licenses expire. This is the default value. `AllowNamespaceAccess`—Package access isn’t blocked for existing users when all custom permission set licenses expire. This field is available in API version 55.0 and later.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Label for this PermissionSetLicenseDefinition value. This display value is the internal label that does not get translated.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org 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 orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless 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 org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
UserLicenseRestrictions	Type textarea Properties Create, Nillable, Update Description The user license categories that can be assigned the custom permission set license. If no user license categories are specified, all users can be assigned the license. Possible values include: `${communities}` `${communitiesLogin}` `${customerCommunities}` `${customerCommunitiesLogin}` `${internal}` `${partnerCommunity}` `${partnerCommunityLogin}` `${platform}` For more information, see User License Restriction Categories (Developer Preview). This field is available in API version 55.0 and later.

Usage

After the PermissionSetLicenseDefinition is created, it must be referenced in LicenseDefinitonCustomPermission.

For more information on custom permission set licenses, see Partner Licensing Platform (Developer Preview) in the ISVforce Developer Guide.