Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
PermissionSetLicenseDefinition (Developer Preview)
Parent Type
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
Fields
| Field Name | Field Type | Description |
|---|---|---|
| customPermissions | PermissionSetLicenseDefinitionCustomPermission | An array of licensed custom permissions included in the permission set license definition. |
| isSupplementLicense | boolean | 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. |
| label | string | Required. The name of the permission set license definition. |
| licenseExpirationPolicy | LicenseExpirationPolicy (enumeration of type string) | The license expiration policy of the custom permission set license. Valid
values are:
|
| userLicenseRestrictions | string | 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:
For more information, see User License Restriction Categories (Developer Preview). This field is available in API version 55.0 and later. |
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.
<?xml version="1.0" encoding="UTF-8"?>
<PermissionSetLicenseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
<customPermissions>>
<name>AccessReportsPerm</name>
</customPermissions>
<isSupplementLicense>false</isSupplementLicense>
<licenseExpirationPolicy>BlockNamespaceAccess</licenseExpirationPolicy>
<label>ExampleFeatureLicenseDefinition</label>
<userLicenseRestrictions>${internal}</userLicenseRestrictions>
</PermissionSetLicenseDefinition>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>PermissionSetLicenseDefinition</name>
</types>
<version>54.0</version>
</Package>Usage
For more information, see the Partner Licensing Platform Developer Guide (Developer Preview).
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.