Skip to main content

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.

In the Embed URL Builder, this is the Model roles field.

​
Requirements

Model roles must be equal to or more permissive than the associated connection’s base access role. For example, if the connection has a base access role of RESTRICTED_QUERIER, it will override a model with a VIEWER role.

​
Syntax

modelRoles=<encoded_object>

​
Properties

​
modelRoles
object
An object containing model ID and role pairs, formatted as "<model_id>: <model_role>". model_role values must the name of a standard user role or the name of a custom user role that resolves to either a Viewer or Restricted Querier.
  • RESTRICTED_QUERIER - Can create new content and view workbooks and dashboards based on the specified model
  • VIEWER - Can only view dashboards based on the specified model
  • <CUSTOM_ROLE_NAME> - Abilities depend on the role’s included permissions
Example input: {"model-id-1":"RESTRICTED_QUERIER", "model-id-2":"CUSTOM_VIEWER"}

​
Examples

The following example demonstrates what the URL encoded version of modelRoles={"65b10d2a-473b-4486-92c8-0ba628c7d1cb":"RESTRICTED_QUERIER"} would be:
Model with Restricted Querier role
modelRoles=%7B%2265b10d2a-473b-4486-92c8-0ba628c7d1cb%22%3A%22RESTRICTED_QUERIER%22%7D