Custom roles are not yet supported. You must use one of the built-in roles listed below.
How roles affect embedded views
Visibility of edit controls, dashboard creation buttons, and AI workstreams is determined by the user’s role assignment. To hide edit controls in an embedded dashboard, assign the user the Viewer role. This role is pure read-only and cannot create or modify any resources.For a full breakdown of what each role can access, see Roles & permission reference below.
Assigning a role at provisioning time
Pass the specificroleId in the roleAssignments array when calling createUsers. Role IDs are unique UUIDs.
Role IDs
Role IDs are passed in theroleAssignments field when provisioning or updating users.
Role IDs are used in the
roleAssignments field of the following mutations:
createUsers— assign a role when provisioning a new embedded usersetUserAttributes— update the role of an existing embedded useraddScopeRoleAssignmentsForSharing— grant a scoped role on a specific dashboardremoveScopeRoleAssignmentsForSharing— remove a scoped role from a specific dashboard
Roles & permission reference
The tables below show the full permission breakdown across all roles and resource types. Use these as a reference when deciding which role to assign for a given use case. For a description of what each role can do, see Access Management.In the API, Story refers to Dashboards. Roles labeled Writer grant edit access to existing resources but do not grant permission to create new ones.
Granular permissions
Granular permissions
Chat
Chat
Dashboard
Dashboard
Users can always view, edit, and clone dashboards they created themselves or that have been shared with them.
Schedule
Schedule
Users can always view and edit schedules they created themselves or that have been shared with them.
Agent
Agent
Users can always view and edit agents they created themselves or that have been shared with them.
Connection
Connection
Domain
Domain
IAM
IAM
Workspace
Workspace
Permission reference
Permission reference
The table below describes what each API permission flag controls.
Related articles
Create Users
Provision embedded users with role assignments
Embed a Dashboard
Use roles to control edit access in embedded dashboards

