Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions docs-mintlify/api-reference/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1982,6 +1982,46 @@ paths:
Signed embedding additionally requires the dashboard to have "Allow signed embedding"
enabled; the trusted screenshoter and creator-mode session flows are exempt. Returns `403`
when embedding is not permitted for the dashboard.
patch:
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: ''
summary: Enable or disable signed embedding for a dashboard
tags:
- Embed
x-mint:
content: >-
**🔒 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.
/v1/embed/generate-session:
post:
operationId: generateSession
Expand Down Expand Up @@ -3284,6 +3324,16 @@ components:
- published
- archived
type: string
DashboardEmbeddingResponse:
properties:
allowEmbed:
type: boolean
publicId:
type: string
required:
- publicId
- allowEmbed
type: object
DashboardFilter:
properties:
caseSensitive:
Expand Down Expand Up @@ -5227,6 +5277,19 @@ components:
- url
- format
type: object
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
UpdateDeploymentInput:
properties:
cloudProvider:
Expand Down
1 change: 1 addition & 0 deletions docs-mintlify/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,7 @@
"openapi": "/api-reference/api.yaml",
"pages": [
"GET /v1/embed/dashboard/{publicId}",
"PATCH /v1/embed/dashboard/{publicId}",
"POST /v1/embed/generate-session",
"POST /v1/embed/session/token"
]
Expand Down
6 changes: 6 additions & 0 deletions docs-mintlify/docs/data-modeling/data-model-ide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ there are any unsaved changes:
<img src="https://ucarecdn.com/67b8e943-0043-4398-84fc-91d83765ed10/" alt="Unsaved changes warning modal" />
</Frame>

You can also link directly into development mode by adding `?devmode=true` to
the Data Model page URL — combine it with `?branch=<name>` to enter dev mode
on a specific branch, or omit `?branch` to use the currently selected branch.
The parameter only takes effect if you already have access to enter dev mode;
otherwise it's ignored.

## Git integration

To add more Git branches to your Cube Cloud deployment and/or switch between
Expand Down
5 changes: 5 additions & 0 deletions docs-mintlify/docs/explore-analyze/scheduled-refreshes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,11 @@ to Slack (or that has notifications turned off) has nothing to subscribe to. If
editor switches a schedule to Slack, its existing subscriptions are cancelled;
you can subscribe again if it is later switched back to email.

Each dashboard refresh email also includes an unsubscribe link in its footer,
and supports one-click unsubscribe from your mail client's native
"Unsubscribe" button (in clients that support it, e.g. Gmail), so recipients
can opt out without signing in to Cube.

## Run phases

When a scheduled refresh runs, it progresses through these phases:
Expand Down
18 changes: 14 additions & 4 deletions docs-mintlify/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ The installer downloads the release binary for your platform and adds it to
your `PATH`. Set `CUBE_VERSION` to pin a release tag, or `CUBE_INSTALL_DIR`
to change the install location.

Running `cube` with no subcommand prints the installed version followed by
the help text, so you can check what's installed at a glance.

The CLI checks for new releases in the background and prints a notice when
one is available. Update in place at any time:

Expand Down Expand Up @@ -154,7 +157,7 @@ Run `cube <command> --help` for the full options of any command.
| `folders`, `workbooks`, `reports`, `workspace` | Workspace content management |
| `users`, `groups`, `attributes`, `policies` | Users, groups, and access control |
| `tenant`, `notifications`, `integrations`, `oidc`, `api-keys` | Account administration |
| `embed` | Embed sessions, tokens, and embed tenants |
| `embed` | Embed sessions, tokens, `enable-dashboard`/`disable-dashboard` (toggle signed embedding for a dashboard, admin only), and embed tenants |
| `agents`, `app`, `meta`, `scim` | Agents, app config, model metadata, SCIM v2 |
| `api` | Raw authenticated API request (escape hatch): `cube api GET /api/v1/... -q key=value -d '{...}'` |
| `update` | Update the CLI to the latest release |
Expand All @@ -165,15 +168,22 @@ output, suitable for piping to `jq`.

## Data model Git workflow

Edit the data model through branches without touching production:
Edit the data model through branches without touching production. File writes
(`put`, `delete`, `rename`) are only accepted on a **dev-mode branch**:

```bash
cube data-model create-branch DEPLOYMENT_ID my-branch --dev-mode
cube data-model put DEPLOYMENT_ID model/cubes/orders.yml --file orders.yml --branch my-branch
# entered dev mode on dev-my-branch (forked from my-branch)
cube data-model put DEPLOYMENT_ID model/cubes/orders.yml --file orders.yml --branch dev-my-branch
cube data-model merge-to-default DEPLOYMENT_ID --branch my-branch -m "add orders cube"
```

`merge-to-default` merges into the deploy branch and rebuilds production.
`--dev-mode` forks a personal `dev-…` branch off the branch you named and
prints it — pass that forked name via `--branch` on write commands (or omit
`--branch` to use your active dev-mode branch). Writes to any other branch are
rejected. `cube data-model dev-mode DEPLOYMENT_ID my-branch` re-enters dev mode
the same way if you're not already in it. `merge-to-default` merges into the
deploy branch and rebuilds production.

## Environment variables

Expand Down
Loading