Skip to main content
GET
List a dashboard's embed access
Return the embed audience of a workbook’s published dashboard: the global allowEmbed (signed-embedding) flag, whether it is shared with all embed users, and the list of individual embed tenants it is shared with. Embed access is a read-only share of the workbook with a system sharing group, so this is scoped to the workbook that owns the dashboard. Requires read access to the workbook. Returns 404 if the workbook does not exist or belongs to a different deployment.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
workbookId
number
required

Response

200 - application/json
allEmbedUsers
object
required
allowEmbed
boolean
required
tenants
object[]
required