Update a dashboard's embed access

PUT /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access

Update a dashboard's embed access

cURL

curl --request PUT \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/embed-access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allEmbedUsers": true,
  "allowEmbed": true,
  "embedTenantName": "<string>"
}
'

200

{
  "allEmbedUsers": {
    "enabled": true,
    "groupId": 123
  },
  "allowEmbed": true,
  "tenants": [
    {
      "embedTenantName": "<string>",
      "groupId": 123
    }
  ]
}

Add, update, or remove one embed audience from a workbook’s published dashboard, and/or toggle signed embedding. Returns the updated embed-access view.

Provide exactly one target — embedTenantName (a single embed tenant) or allEmbedUsers: true (every embed tenant) — together with action: "read" grants access, "none" removes it. Include allowEmbed to also flip “Allow signed embedding” in the same request; omit both targets to change only allowEmbed.

Requires manage access to the workbook. Returns 404 if the workbook or the named embed tenant does not exist, and 400 if the request specifies no change or sets allowEmbed on a workbook that has no published dashboard.

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId · number · required

workbookId · number · required

Body

application/json

UpdateEmbedAccessInput

action · enum<string> | null

Available options: read, none

allEmbedUsers · boolean | null

allowEmbed · boolean | null

embedTenantName · string | null

Response

200 - application/json

allEmbedUsers · object · required

Show child attributes

allowEmbed · boolean · required

tenants · object[] · required

Show child attributes