PermissionSetLicenseDefinition

Represents the definition of a custom permission set license, which entitles specified features in a package. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

Field Details
ComponentAccess
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Allows access to an associated component. Possibel values include:
  • None
  • Namespace
CreatedById
Type
reference
Properties
Defaulted on create, Filter
Description
ID of the User who created this record.
CreatedDate
Type
dateTime
Properties
Defaulted on create, Filter
Description
Date and time when this record was created.
DefaultTrialLengthInDays
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Required. Default trial length in days.
DefaultTrialLicenseCount
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Required. Default number of trial licenses provisioned for a trial.
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, must be unique in your organization, and has a limit of 80 characters. 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.
Id
Type
id
Properties
Create, Filter, Group, Sort, Update
Description
Unique record ID.
IsDeleted
Type
boolean
Properties
Create, Filter, Group, Sort, Update
Description
When true, the record has been deleted.
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.
LastModifiedById
Type
reference
Properties
Defaulted on create, Filter
Description
ID of the User who last updated this record.
LastModifiedDate
Type
dateTime
Properties
Defaulted on create, filter
Description
Date and time when a user last modified this record.
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. Limit: 80 characters.
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.
SystemModstamp
Type
dateTime
Properties
Defaulted on create, filter
Description
In general, SystemModstamp shows the date and time when a user or automated process last modified the record. However, in certain cases, SystemModstamp doesn’t capture every field change. For example, if object A retrieves values from object B, then the changes to field values in records on object B are reflected in the SystemModstamp field for records on object B, but not on object A.
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}

Usage

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