Skip to main content
Defines the level of access users will have for individual models in a connection. In the Embed URL Builder, this is the Model roles field.

Syntax

Properties

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
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.

Examples

In the v1 signed payload format, send the value as JSON:
v1 payload