- 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 | 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. |
Recommended arameters
The following parameters are strongly recommended, but not required, in embed requests.| 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. |
| 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. |
| 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. |
| uiSettings | Controls general settings of the application in embed. |
| userAttributes | Applies user attributes to the embed user. |