warning icon

Deprecation Warning: This API is deprecated and it is scheduled to be removed on 03/01/2022. Please use (or migrate to) the new version of the Viewer Authentication.

Besides the player there are some services (such as Chat, Q&A and Combined Embed) that may also require viewer authentication. In order to make the authentication work across these services, additional steps need to be taken at the end of the authentication flow.

These services provide a URL, that must be used instead of the default pass url. This URL is sent in the hashConsumer query parameter by the service to the application.

Example url in the hashConsumer for chat:

https://video.ibm.com/chat/authorize/12345678?resource=%2Fchat%2F12345678
Copy to clipboard

Example script in native PHP that can authenticate the player and the services as well

// Given a json token has already been constructed
$json = json_encode($response);

// Default hash consumer for the player
$hashConsumer = 'https://video.ibm.com/embed/hashlock/pass';
$query = [];

// Check if there is a special hash consumer
if (!empty($_GET['hashConsumer'])) {
Copy to clipboard

Edit this page on GitHub

Deprecated: Hash lifetime and expiration

Deprecated: Hash Authentication Test

Deprecated - Using viewer authentication with other services