> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Embed URL parameters reference

> Create and customize user sessions by including URL parameters in your embed requests.

For example, you can use embed URL parameters to:

* Specify user content roles
* Assign connection and model roles to users
* Control the look and theme of your embedded application
* Apply user attributes to users

## Required parameters

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

| Parameter                                              | Description                                                         |
| ------------------------------------------------------ | ------------------------------------------------------------------- |
| [contentPath](/embed/setup/url-parameters/contentPath) | Defines the starting page when the embed user logs into the iframe. |
| [externalId](/embed/setup/url-parameters/externalId)   | Creates a unique ID for the embed user.                             |
| [name](/embed/setup/url-parameters/name)               | Defines a non-unique name for the embed user's name property.       |
| [nonce](/embed/setup/url-parameters/nonce)             | A unique 32-character string that defines the embed login URL.      |

## Recommended parameters

The following parameters are strongly recommended, but not required, in embed requests.

| Parameter                                                      | Description                                                                               |
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [connectionRoles](/embed/setup/url-parameters/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](/embed/setup/url-parameters/accessBoost)                                         | Enables AccessBoost for the embedded dashboard.                                                 |
| [customTheme](/embed/setup/url-parameters/customTheme)                                         | Defines custom theme properties for styling embedded dashboards.                                |
| [customThemeId](/embed/setup/url-parameters/customThemeId)                                     | Defines a theme ID from your Omni instance to stylize embedded dashboards.                      |
| [email](/embed/setup/url-parameters/email)                                                     | Populates the from email for entity users when sharing content or sending deliveries.           |
| [entity](/embed/setup/url-parameters/entity)                                                   | Defines a user group identifier used to associate the resulting embed user with a larger group. |
| [entityFolderContentRole](/embed/setup/url-parameters/entityFolderContentRole)                 | Specifies the content role the embed user will be given to their shared entity folder.          |
| [entityFolderGroupContentRole](/embed/setup/url-parameters/entityFolderGroupContentRole)       | Specifies the content role the embed entity group will be given to their shared entity folder.  |
| [entityFolderLabel](/embed/setup/url-parameters/entityFolderLabel)                             | Updates the embed user's associated entity folder label.                                        |
| [entityGroupLabel](/embed/setup/url-parameters/entityGroupLabel)                               | Updates the embed user's associated entity group label.                                         |
| [filterSearchParam](/embed/setup/url-parameters/filterSearchParam)                             | Specifies the filters to apply for the embedded content.                                        |
| [groups](/embed/setup/url-parameters/groups)                                                   | Associates the resulting embed user with existing user groups in your Omni instance.            |
| [linkAccess](/embed/setup/url-parameters/linkAccess)                                           | Controls which Omni dashboards can be linked to from the embedded dashboard.                    |
| [mode](/embed/setup/url-parameters/mode)                                                       | Defines the type of access users will have to Omni in the iframe.                               |
| [modelRoles](/embed/setup/url-parameters/modelRoles)                                           | Defines the level of access users will have for individual models in a connection.              |
| [prefersDark](/embed/setup/url-parameters/prefersDark)                                         | Controls whether the resulting embed session has a light or dark mode appearance.               |
| [preserveEntityFolderContentRole](/embed/setup/url-parameters/preserveEntityFolderContentRole) | Retains the embed user's existing entity folder content role.                                   |
| [theme](/embed/setup/url-parameters/theme)                                                     | Customizes the styles of the resulting embed session with a built-in Omni application theme.    |
| [uiSettings](/embed/setup/url-parameters/uiSettings)                                           | Controls general settings of the application in embed.                                          |
| [userAttributes](/embed/setup/url-parameters/userAttributes)                                   | Applies user attributes to the embed user.                                                      |