Login

Learning & Support

Documentation

How to pass a Custom Entitlements Server token to the Browser Client?

Twixl Support Team Updated: - Created :

In some cases, it might be interesting to pass the login from a Custom Entitlements Server directly to the Browser Client of your article-based apps. This KB-article explains possible reasons (scenarios), requirements and how to do this.

Why could this be useful?  

Your article-based app is an in-house app and is linked to an internal tool (a CRM, Salesforce, Microsoft Sharepoint, ...). To make content available via the Browser Client, you provide urls in your internal company tool that link directly to the Browser Client without the need for the user to login again.

Requirements

What do you need?

ABOUT THE BUILT-IN ENTITLEMENT SCENARIOS:

When you are not using a Custom Entitlements Server, it's technically possible to use this Advanced Feature with one of the built-in Entitlements scenarios. But this will require you to use our API and the setup will be much more complex. Furthermore, most use cases are all about connecting the Browser Client with users from internal company tools. And in the vast majority of those cases, that's why a Custom Entitlements Server is needed anyway.

How to setup?

By using the query string paremeter called twx-set-entitlement-token, you can tell the Browser Client to use that specific Entitlement Token. It will set the token and force a redirect to the same url without the entitlement token parameter. As such, you'll need to construct your url as following:

https://[browserclient-url]?twx-set-entitlement-token=[token]

Possible examples

https://browserclient.twixlmedia.com/app-key?twx-set-entitlement-token=user-1@company-a.com
  • https://browserclient.twixlmedia.com/app-key : In this case, the url is a default Twixl URL without Custom Domain (see The Browser Client for more info).
  • ?twx-set-entitlement-token= : This query string parameter is necessary to call the next part of the url, the token.
  • user-1@company-a.com : The token is in this case an email address. This could have been a username or something else (depending on the method used in your inhouse tool).
https://demoapp.company-a.com?twx-set-entitlement-token=user1
  • https://demoapp.company-a.com : In this case, the url is a Custom Domain linking to your Browser Client (see The Browser Client for more info about using Custom Domains).
  • ?twx-set-entitlement-token= : This query string parameter is necessary to call the next part of the url, the token.
  • users1 : The token is in this case a username. This could have been an access code, an email address or something else (depending on the method used in your internal company tool).

Was this article helpful?

0 out of 0 found this helpful