Create a team for embed users

You must create at least one team for embed users to facilitate access to securely embedded Sigma content. This team can also optionally support workspaces and data permissions for embed users.

Create an embed team

When an embed user accesses a secure embed for the first time and is not an existing member of your Sigma organization, Sigma automatically creates a new user based on the email address used to log into the host application. This user is assigned to a specific Sigma team defined by the teams claim for an embed signed with JSON Web Tokens (JWTs) or by the external_user_team parameter in the embed URL if you are not using JWTs.

Before you configure a secure embed, you must create this team and (optionally) grant team-level data permissions to determine embed user access. For more information, see Create and manage teams and Manage data permissions.

📘

Embed user accounts are also assigned to a specific account type defined by the account_type claim for an embed signed with JWTs or by the account_type parameter in an embed URL without JWTs. This claim or parameter can reference a default account type, or you can create and assign a custom account type. For more information, see User account types > Custom account types.

Share the content you want to embed with the embed team

To embed Sigma content in a host application, the content must be published in a workbook within your Sigma organization. You can create a workbook specifically for the embedded content, or you can use content in an existing workbook that serves other purposes. For step-by-step instructions, see Create a workbook and Draft and publish a workbook.

By sharing the published workbook with an embed user team, you ensure that the users can view the embedded content as intended. You can share a workbook with multiple embed user teams and grant each team different permissions (for example, you can grant one team Can explore permission and the other Can view permission) to control access and interactions with the content in the host application. For step-by-step instructions, see Share a workbook.