Migrate from Temporary Token to Embed Token

1:40 min
Medium

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 combine the best of SSO and Temporary Tokens, 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 Temporary Tokens is straightforward! Just make a few tweaks to your backend code (where you currently request temporary tokens).

Making the Switch:

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

  • Change the type to "embed"
  • Add these user details:
    • Username, identifying the end-user uniquely and immutably
    • Email
    • Name
  • Use the new "access" property: This replaces the old "securables" property and lets you specify access to dashboards, datasets, and collections.
  • Use the new "parameter_overrides" property: This property now controlls 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 temporary key&token for an Embed key&token when embedding the dashboard (more info in this Academy article).

Bonus! Multi-Tenancy Made Easy:

Embed Tokens work seamlessly with the Access Control Layer for multi-tenancy setups. Use Embed Filters at the dataset level to prepare your environment (more info in this article).

Need more information?

Do you still have questions? Let us know how we can help.
Send us feedback!

Related Articles

Adding dashboards to a Next.js application
Applying external filter components to an embedded Luzmo dashboard
1:30
Custom dashboard versioning
2:00
Custom events
3:00
Drilling through to another dashboard in your application
6:40
Dynamically initializing a Date filter in the Authorization request
Dynamically initializing a Slider filter in the Authorization request
Dynamically Initializing Dropdown or a Slicer Filter in Embed Tokens
Embed dashboards and/or the dashboard editor in your frontend
3:00
Embedding a Single Chart In Your Application
0:50
How to query a dataset via our API
10:00
Introducing embedded dashboards and the Embedded Dashboard Editor
2:30
Loading a dashboard in the same filter state as a user left it
Managing the access granularity of your dashboards and datasets
10:00
Migrate from Temporary Token to Embed Token
1:40
Multi-tenancy: an overview of the possibilities
2:00
Multi-tenancy by adding static filters
3:30
Multi-tenancy by overriding data source properties
3:30
Multi-tenancy by using parameter filters
2:30
Multi-tenancy via a plugin with internal logic by adding metadata to your embed authorization request
4:00
Parameter types for parameterizable filters
Request an embed token in your backend
3:30
Retrieving a List of All Dashboards Using a Specific Dataset and Vice Versa with the API
2:00
Supporting different development environments
4:00
Using additional data in interactivity features
What is possible with dashboards integrated with embed tokens?
3:30