Migrate from SSO Token to Embed Token

Important Update: SSO and Temporary Tokens are Deprecated

Starting February 28, 2025, the legacy SSO Token and Temporary Token authentication methods will no longer be supported.

All new features and enhancements will be available exclusively with Embed Tokens.

To continue benefiting from the latest improvements and ensure compatibility with future updates, transitioning to Embed Tokens is essential. They offer enhanced security, greater flexibility, and improved access control.

We strongly recommend migrating to Embed Tokens as soon as possible. For detailed migration steps, please refer to the instructions provided in this article.

Upgrade your access management with Embed Tokens!

Embed Tokens are the new and improved way to control who sees your embedded content. They offering more customization and future-proofing your setup.

Here's what Embed Tokens bring to the table:

• Granular Access Control: Grant access exactly what your users need – dashboards, datasets, or collections – with a powerful mix-and-match approach. Collections help you organize everything neatly! Learn more about Collections and Access Control Layer.
• Always Up-to-Date: New features will only work with Embed Tokens. Switching ensures you benefit from the latest and greatest access management.
• Easy Migration: The switch from SSO Tokens is straightforward! You just need to migrate your integrations and make a few tweaks to your backend code (where you currently request sso tokens).

Migrating from Integrations to Collections

• 1. Create Collections based on your integrations. You can add dashboards AND datasets to the same Collection. Then you can provide access to the embed users through this Collection using the collection_id.
• Add access to specific dashboards or datasets outside of a Collection

We released a script to automate the migration from Integrations to Collections. If you have many integrations it can help to migrate faster (more info on Github)

• 2. Create Embed Filters through the UI

Embed filters replace the filters you applied on your Integrations. More information on setting up multi-tenancy using Embed Filters

• 3. Create the Embed token following the steps below.

Changing your token request:

Here's a quick rundown of what to change in your backend code:

• Change the type to "embed"
• Remove integration_id property
• Use the new "access" property:: use this property to grant access to your assets. Specify the Collection(s), dashboard(s) and/or dataset(s) ID(s) you want to give access to, as well as the corresponding rights associated with the asset.
• • Use the new "parameter_overrides" property: This property now controls all parameter overrides for embed filters and dashboard filters linked to parameters. The "metadata" property can still be used to send metadata to custom plugins. Learn more about Embed filters.

Optional Adjustments:

• Expiry: The format is now a proper timestamp (like 2024-04-12T15:29:00Z). It defaults to 24 hours but can go up to 1 year. We advise using a short expiry time, eg. 24 hours from now.
• Inactivity Interval: This is how long the token is valid after no activity (in seconds). It defaults to 0, a value of 0 means no premature invalidation due to inactivity. For non-zero values the minimum is 120 seconds, this is to avoid accidental invalidation for a dashboard that is still open, eg. when a heartbeat signal sent to the server is missed.

See the following article for the full explanation of Requesting an embed token in your backend, the different properties, a code example and others.

Frontend Code:

Your frontend code will still work the same way! Just swap the SSO key&token for an Embed key&token when embedding the dashboard (more info in this Academy article).