> ## Documentation Index
> Fetch the complete documentation index at: https://cubed3-claude-gallant-ramanujan-ae69ly.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Enable or disable signed embedding for a dashboard

**🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.

Sets the dashboard's "Allow signed embedding" flag (`allowEmbed`), which gates the customer-signed embedding path: with the flag off, embed sessions fetching `GET /v1/embed/dashboard/{publicId}` receive `403`. Trusted cube-cloud session flows (screenshoter, creator mode) and dashboards shared with all embed users are not affected by this flag.

Note that the flag alone does not make a dashboard embeddable — it must also be published and shared with the embed tenant. Returns `404` if the dashboard does not exist.


## OpenAPI

````yaml /api-reference/api.yaml patch /v1/embed/dashboard/{publicId}
openapi: 3.1.0
info:
  title: Cube Cloud REST API
  version: 1.0.0
  description: >-
    Programmatically manage Cube Cloud: deployments and everything scoped to
    them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
servers:
  - url: https://{tenant}.cubecloud.dev/api
    description: >-
      Cube Cloud API base URL. Replace the whole host if you use a custom
      domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube Cloud tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Environments
  - name: Folders
  - name: Reports
  - name: Workbooks
  - name: Notifications
  - name: Workspace
  - name: User Attributes
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dbt Sync
  - name: Env Variables
  - name: OAuth Integrations
  - name: OIDC Token Configs
  - name: Regions
  - name: Tenant Settings
  - name: User Attribute Values
  - name: User OAuth Tokens
  - name: Users Admin
paths:
  /v1/embed/dashboard/{publicId}:
    patch:
      tags:
        - Embed
      summary: Enable or disable signed embedding for a dashboard
      operationId: updateDashboardEmbedding
      parameters:
        - in: path
          name: publicId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDashboardEmbeddingInput'
        description: UpdateDashboardEmbeddingInput
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardEmbeddingResponse'
          description: ''
components:
  schemas:
    UpdateDashboardEmbeddingInput:
      properties:
        allowEmbed:
          description: >-
            Whether customer-signed embedding is allowed for this dashboard
            ("Allow signed embedding" in the UI). `true` lets embed sessions
            fetch the dashboard via `GET /v1/embed/dashboard/{publicId}`;
            `false` makes that fetch return `403`. Does not affect creator-mode
            sessions or dashboards shared with all embed users.
          type: boolean
      required:
        - allowEmbed
      type: object
    DashboardEmbeddingResponse:
      properties:
        allowEmbed:
          type: boolean
        publicId:
          type: string
      required:
        - publicId
        - allowEmbed
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````