Type (Entitlement) Property

Version: Available or changed with runtime version 7.0.

The type of entitlement. When a user logs into Business Central, it's checked if the user is assigned the given Microsoft Entra service plan, the given Microsoft Entra role etc., and if that's the case, the user will be entitled to use the objects covered by this entitlement. The same applies if an application logs into Business Central.

Applies to

  • Entitlement

Property Value

Value Description
PerUserServicePlan The entitlement is associated with a Microsoft Entra service plan which is licensed to specific users.
PerUserOfferPlan The entitlement is associated with an offer, which is licensed to specific users.
FlatRateServicePlan The entitlement is associated with a Microsoft Entra service plan which is licensed to a Microsoft Entra tenant
Role The entitlement is associated with a Microsoft Entra role.
ConcurrentUserServicePlan The entitlement is associated with a named Microsoft Entra group.
Application The entitlement is associated with a Microsoft Entra application.
ApplicationScope The entitlement is associated with a Microsoft Entra application scope.
Implicit Internal use only.
Unlicensed Entitlement applied when no other entitlements from an app has been applied. This type is used to enable side-by-side support for transactability-enabled apps on AppSource. For more information, see Selling Business Central apps through AppSource.
Group The entitlement is associated with a specific Microsoft Entra group, identified by the object ID specified in the id property. For more information, see Selling Business Central apps through AppSource.

Remarks

Note

Azure Active Directory is now Microsoft Entra ID. Learn more

Note

With Business Central 2023 release wave 1, the entitlement type Unlicensed is introduced. This type is used for scenarios when the user isn't licensed through entitlements mapping to AppSource offer plans.

The Unlicensed type of entitlement is only applied to users who don't have a plan, that is a license, defined in the app’s entitlements. You can test for the unlicensed scenario and perform your custom licensing as before for existing customers, allowing side-by-side support while transitioning existing customers to the new AppSource transactability model. For more information, see Selling Business Central apps through AppSource.

When Type is set to Role, the RoleType Property is used to further define whether the RoleType is Local or Delegated.

Syntax

The following code snippet, shows how to use the Type property in the entitlement object. For more information, see Entitlement object.

entitlement MyEntitlement
{
    ...
    Type = Role;                    // Entitlement type, if Role, then specify RoleType property
    RoleType = Delegated;
    ObjectEntitlements = 
        ”D365 BUS PREMIUM - BaseApp”;​
}

Get Started with AL
Entitlement object
Type (Report) Property