PermissionSetLicenseDefinition (Developer Preview)

Represents the definition of a custom permission set license, which entitles specified features in a package.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

PermissionSetLicenseDefinition components have the suffix .permissionSetLicenseDefinition and are stored in the permissionSetLicenseDefinitions folder.

Version

PermissionSetLicenseDefinition components are available in API version 54.0 and later.

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 Name	Field Type	Description
customPermissions	PermissionSetLicenseDefinitionCustomPermission	An array of licensed custom permissions included in the permission set license definition.
label	string	Required. The name of the permission set license definition.

PermissionSetLicenseDefinitionCustomPermission

Represents a licensed custom permission included in the permission set license definition.

Field Name	Field Type	Description
name	string	Label of the licensed custom permission. This field must be a reference to a CustomPermission that has the isLicensed field set to `true`.

Declarative Metadata Sample Definition

The following is an example of a PermissionSetLicenseDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PermissionSetLicenseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <customPermissions>>
4        <name>AccessReportsPerm</name>
5    </customPermissions>
6    <label>ExampleFeatureLicenseDefinition</label>
7</PermissionSetLicenseDefinition>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>PermissionSetLicenseDefinition</name>
6    </types>
7    <version>54.0</version>
8</Package>

Usage

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

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide