Embed URL parameters reference

How these parameters are included in an embed URL depends on its signing format. In the v1 signed payload format, all parameters are carried inside a single payload parameter, and JSON-valued parameters such as userAttributes stay as JSON instead of being stringified and URL encoded. In the legacy v0 format, each parameter is sent as its own URL parameter.A v1 payload also carries an exp expiry that isn’t listed below as it isn’t something you set per session in the same way. See URL expiry for more information.

Required parameters

At a minimum, valid embed requests must contain all of the following parameters:

Parameter	Description
contentPath	Defines the starting page when the embed user logs into the iframe.
externalId	Creates a unique ID for the embed user.
name	Defines a non-unique name for the embed user’s name property.
nonce	A unique 32-character string that defines the embed login URL.

Parameter	Description
connectionRoles	Specifies the level of access users will have to all models associated with a connection.

Parameter

Description

connectionRoles

Specifies the level of access users will have to all models associated with a connection.

Optional parameters

The following parameters are optional in embed requests.

Parameter	Description
accessBoost	Enables AccessBoost for the embedded dashboard.
customTheme	Defines custom theme properties for styling embedded dashboards.
customThemeId	Defines a theme ID from your Omni instance to stylize embedded dashboards.
email	Populates the from email for entity users when sharing content or sending deliveries.
entity	Defines a user group identifier used to associate the resulting embed user with a larger group.
entityAiCreditLimit	Sets an AI credit limit for the embed user’s entity group at login.
entityFolderContentRole	Specifies the content role the embed user will be given to their shared entity folder.
entityFolderGroupContentRole	Specifies the content role the embed entity group will be given to their shared entity folder.
entityFolderLabel	Updates the embed user’s associated entity folder label.
entityGroupLabel	Updates the embed user’s associated entity group label.
filterSearchParam	Specifies the filters to apply for the embedded content.
groups	Associates the resulting embed user with existing user groups in your Omni instance.
linkAccess	Controls which Omni dashboards can be linked to from the embedded dashboard.
mode	Defines the type of access users will have to Omni in the iframe.
modelRoles	Defines the level of access users will have for individual models in a connection.
prefersDark	Controls whether the resulting embed session has a light or dark mode appearance.
preserveEntityFolderContentRole	Retains the embed user’s existing entity folder content role.
theme	Customizes the styles of the resulting embed session with a built-in Omni application theme.
timezone	Specifies a timezone override for query execution in the embedded session.
uiSettings	Controls general settings of the application in embed.
userAttributes	Applies user attributes to the embed user.

Getting started

Setup

App customization

Events & interactivity

Admin

Embed URL parameters reference

Required parameters

Recommended parameters

Optional parameters

​Required parameters

​Recommended parameters

​Optional parameters

Required parameters

Recommended parameters

Optional parameters