It’s important to understand that the Kaltura platform supports multiple access control mechanisms (I’m referring to the application layer here; naturally, we apply ACL restrictions at the lower layers as well - networking [layer 3 in OSI terms] and transport [layer 4]).
The mechanism that is of interest in this scenario is called content entitlements. For a high level overview, please see:
The way to determine whether a certain API request should be allowed is by looking at the KS (Kaltura Session) parameter.
This is true to all API requests, made by Kaltura’s own applications (KMC, MediaSpace, etc) as well as third party/customer applications.
A KS consists of multiple fields, the most important ones being:
- Partner ID
- Expiration date (represented as a UNIX/Epoch timestamp)
- Type (USER or ADMIN)
- user ID
A detailed explanation of the KS mechanism can be found here:
To better illustrate the above, please consider this output (the result of decoding the KS string):
valid_until 1564681348 = 2019-08-01 17:42:28 (will expire in 23 hours and 59 minutes)
In the example above, because the KS was generated with these privileges:
If you attempt to use it to view a different entry ID, it will also fail.
privileges field can be used to limit the actions that can be performed with the KS in question.
For the use-case at hand, we only want the KS to allow playback and therefore, the
sview privilege is sufficient.
sview:$ENTRY_ID in the
privileges field when generating the KS, one can limit playback to one specific entry, which is the desired behaviour here.
As is always the case, the principle of least privilege (PoLP) applies.
There are two main methods for generating a KS:
Both methods allow you to set a specific user ID and the desired privileges and select the session type (you’ll want a USER session in this case, not ADMIN).
For the employee dashboard, you will probably want to call session.start() since you don’t want its code to have to know the user’s password.
Kaltura has official API clients for many different languages.
A full list can be found here: https://developer.kaltura.com/api-docs/Client_Libraries.
we also offer a mechanism called appToken, which you can read about here:
The main advantage of using that method is that a given token can easily be revoked whereas, if the
admin secret needs to be changed, you will have to put the request to us.
So, in conclusion, you need to either:
- Generate a KS as per the above and include that in your embed code (see example below)
- Associate the entry IDs in question with categories for which no entitlement enforcement is enabled (this is the default when creating a category in KMC)
Here’s a sample embed code with the
<div id="kaltura_player" style="width: 528px; height: 327px;"></div>