How to Add Entitlements to Categories - KMC

Entitlement Settings

Entitlement settings may be added to categories integrated into applications to support content entitlement.

From the Integration Settings page you control to which categories in your account, entitlement settings are added and enforced. See Managing Content Entitlement for more information.

The Entitlement Settings option in the Integration Settings page is available with entitlement account configuration only.

Use the "Privacy Context" to add the entitlement to categories.

Privacy Context is a free text label that indicates to which application the entitlement settings apply, for example, “MediaSpace”. The Privacy Context label is used for specific indexing of categories and content associated with it, and should also be configured in the application session (KS) itself.  The Privacy Context configuration for an application guarantees the following:

  • User’s entitlements to content in the application are determined based on the specific categories the application is integrated with. 
  • Categories that are not directly integrated with the application can be used for any content organization and applicative classification purposes. A content item can be shared with such categories with no impact on their visibility to end-users through the application.

In the common case, a single Privacy Context should be set to an entire ‘branch’ within the category-tree, and indicate the application integrated with it. In more complex scenarios, multiple privacy contexts can be set to categories to enable access to content shared between multiple applications within the account, and under the same organizational context.

The Privacy Context is set to categories as part of the MediaSpace installation process. Following this configuration, the MediaSpace categories can be edited to include entitlements settings.

For any other purposes, entitlements and privacy context can be added to categories from the Integration Settings page in the KMC.

By default, all accounts have a limit of how many categories an entry can be in. This category limit is set to 1000 categories per entry and should be sufficient in most cases.
Enabling the 'Disable category limit' feature on the account admin console will raise this bar limit. However, it might cause issues in applications using those categories in case multiple Privacy Context labels exists on the same root category. To avoid unexpected issues, make sure to remove the excess Privacy Context label, and keep the same label setting as on the KMS admin page.
Enabling this feature might also eliminate the API call 'baseEntry->update' used for updating the categories. Instead the API call 'categoryEntry->add/delete' may be used.

To add entitlements to categories

  1. Select the Settings tab and then select Integration Settings.
  2. In the Entitlement Settings sections click Add Entitlements to Categories.
  3. Enter the name of the root category integrated with your application/s.
  4. Enter the privacy context label. Multiple labels can be separated by commas. In MediaSpace, the privacy context label is visible through the MediaSpace configuration panel.
  5. Click Apply.
    Following this action, the categories tree is updated in the Kaltura backend, and the privacy context is gradually propagated into all sub categories. This operation may take a few minutes.

If entitlement enforcement is enabled by default in your account, after you complete this step, all content under the category that was set with entitlements (including all sub-categories) will only be accessible through an application that was updated to work with Kaltura’s entitlement services and that is set with the defined privacy context label as part of its session privileges.

To edit/delete entitlements
  1. In the Entitlement Settings section, click on the 3 dots next to the entitlement you want to edit or delete.
  2. Select Edit to edit the Privacy Context label for the Entitlement.
  3. Select Delete to delete the entitlement assigned to the category. 

Entitlement settings will be removed from all sub-categories in an asynchronous process. This operation may take a few minutes. Any previous privacy settings defined for the selected category (including all sub-categories) will be lost.

In This Article
Was this article helpful?
Thank you for your feedback!