Generate an embed session

POST /v1/embed/generate-session

Generate an embed session

cURL

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/embed/generate-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": 123,
  "creatorMode": true,
  "email": "<string>",
  "embedTenantName": "<string>",
  "embedTenantProfile": {
    "displayName": "<string>"
  },
  "embedTheme": {
    "analyticsChat": {
      "backgroundColor": "<string>",
      "chatInput": {
        "backgroundColor": "<string>",
        "borderColor": "<string>"
      }
    },
    "chat": {
      "inputColor": "<string>"
    },
    "font": "<string>",
    "primaryColor": "<string>"
  },
  "externalId": "<string>",
  "groupDefinitions": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "groups": [
    "<string>"
  ],
  "internalId": "<string>",
  "isEphemeral": true,
  "publicDashboardId": "<string>",
  "roles": [
    "<string>"
  ],
  "securityContext": {},
  "settings": {
    "showDashboardChat": true
  },
  "tenantGroupDefinitions": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "tenantGroups": [
    "<string>"
  ],
  "userAttributeDefinitions": [
    {
      "name": "<string>",
      "defaultValue": "<string>",
      "description": "<string>",
      "displayName": "<string>"
    }
  ],
  "userAttributes": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "userProfile": {
    "displayName": "<string>",
    "picture": "<string>"
  }
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed/generate-session"

payload = {
    "deploymentId": 123,
    "creatorMode": True,
    "email": "<string>",
    "embedTenantName": "<string>",
    "embedTenantProfile": { "displayName": "<string>" },
    "embedTheme": {
        "analyticsChat": {
            "backgroundColor": "<string>",
            "chatInput": {
                "backgroundColor": "<string>",
                "borderColor": "<string>"
            }
        },
        "chat": { "inputColor": "<string>" },
        "font": "<string>",
        "primaryColor": "<string>"
    },
    "externalId": "<string>",
    "groupDefinitions": [
        {
            "name": "<string>",
            "description": "<string>"
        }
    ],
    "groups": ["<string>"],
    "internalId": "<string>",
    "isEphemeral": True,
    "publicDashboardId": "<string>",
    "roles": ["<string>"],
    "securityContext": {},
    "settings": { "showDashboardChat": True },
    "tenantGroupDefinitions": [
        {
            "name": "<string>",
            "description": "<string>"
        }
    ],
    "tenantGroups": ["<string>"],
    "userAttributeDefinitions": [
        {
            "name": "<string>",
            "defaultValue": "<string>",
            "description": "<string>",
            "displayName": "<string>"
        }
    ],
    "userAttributes": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "userProfile": {
        "displayName": "<string>",
        "picture": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deploymentId: 123,
    creatorMode: true,
    email: '<string>',
    embedTenantName: '<string>',
    embedTenantProfile: {displayName: '<string>'},
    embedTheme: {
      analyticsChat: {
        backgroundColor: '<string>',
        chatInput: {backgroundColor: '<string>', borderColor: '<string>'}
      },
      chat: {inputColor: '<string>'},
      font: '<string>',
      primaryColor: '<string>'
    },
    externalId: '<string>',
    groupDefinitions: [{name: '<string>', description: '<string>'}],
    groups: ['<string>'],
    internalId: '<string>',
    isEphemeral: true,
    publicDashboardId: '<string>',
    roles: ['<string>'],
    securityContext: {},
    settings: {showDashboardChat: true},
    tenantGroupDefinitions: [{name: '<string>', description: '<string>'}],
    tenantGroups: ['<string>'],
    userAttributeDefinitions: [
      {
        name: '<string>',
        defaultValue: '<string>',
        description: '<string>',
        displayName: '<string>'
      }
    ],
    userAttributes: [{name: '<string>', value: '<string>'}],
    userProfile: {displayName: '<string>', picture: '<string>'}
  })
};

fetch('https://{tenant}.cubecloud.dev/api/v1/embed/generate-session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/embed/generate-session",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deploymentId' => 123,
    'creatorMode' => true,
    'email' => '<string>',
    'embedTenantName' => '<string>',
    'embedTenantProfile' => [
        'displayName' => '<string>'
    ],
    'embedTheme' => [
        'analyticsChat' => [
                'backgroundColor' => '<string>',
                'chatInput' => [
                                'backgroundColor' => '<string>',
                                'borderColor' => '<string>'
                ]
        ],
        'chat' => [
                'inputColor' => '<string>'
        ],
        'font' => '<string>',
        'primaryColor' => '<string>'
    ],
    'externalId' => '<string>',
    'groupDefinitions' => [
        [
                'name' => '<string>',
                'description' => '<string>'
        ]
    ],
    'groups' => [
        '<string>'
    ],
    'internalId' => '<string>',
    'isEphemeral' => true,
    'publicDashboardId' => '<string>',
    'roles' => [
        '<string>'
    ],
    'securityContext' => [
        
    ],
    'settings' => [
        'showDashboardChat' => true
    ],
    'tenantGroupDefinitions' => [
        [
                'name' => '<string>',
                'description' => '<string>'
        ]
    ],
    'tenantGroups' => [
        '<string>'
    ],
    'userAttributeDefinitions' => [
        [
                'name' => '<string>',
                'defaultValue' => '<string>',
                'description' => '<string>',
                'displayName' => '<string>'
        ]
    ],
    'userAttributes' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'userProfile' => [
        'displayName' => '<string>',
        'picture' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.cubecloud.dev/api/v1/embed/generate-session"

	payload := strings.NewReader("{\n  \"deploymentId\": 123,\n  \"creatorMode\": true,\n  \"email\": \"<string>\",\n  \"embedTenantName\": \"<string>\",\n  \"embedTenantProfile\": {\n    \"displayName\": \"<string>\"\n  },\n  \"embedTheme\": {\n    \"analyticsChat\": {\n      \"backgroundColor\": \"<string>\",\n      \"chatInput\": {\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\"\n      }\n    },\n    \"chat\": {\n      \"inputColor\": \"<string>\"\n    },\n    \"font\": \"<string>\",\n    \"primaryColor\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"groupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"internalId\": \"<string>\",\n  \"isEphemeral\": true,\n  \"publicDashboardId\": \"<string>\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"securityContext\": {},\n  \"settings\": {\n    \"showDashboardChat\": true\n  },\n  \"tenantGroupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"tenantGroups\": [\n    \"<string>\"\n  ],\n  \"userAttributeDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"defaultValue\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"userAttributes\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"userProfile\": {\n    \"displayName\": \"<string>\",\n    \"picture\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.cubecloud.dev/api/v1/embed/generate-session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": 123,\n  \"creatorMode\": true,\n  \"email\": \"<string>\",\n  \"embedTenantName\": \"<string>\",\n  \"embedTenantProfile\": {\n    \"displayName\": \"<string>\"\n  },\n  \"embedTheme\": {\n    \"analyticsChat\": {\n      \"backgroundColor\": \"<string>\",\n      \"chatInput\": {\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\"\n      }\n    },\n    \"chat\": {\n      \"inputColor\": \"<string>\"\n    },\n    \"font\": \"<string>\",\n    \"primaryColor\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"groupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"internalId\": \"<string>\",\n  \"isEphemeral\": true,\n  \"publicDashboardId\": \"<string>\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"securityContext\": {},\n  \"settings\": {\n    \"showDashboardChat\": true\n  },\n  \"tenantGroupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"tenantGroups\": [\n    \"<string>\"\n  ],\n  \"userAttributeDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"defaultValue\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"userAttributes\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"userProfile\": {\n    \"displayName\": \"<string>\",\n    \"picture\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed/generate-session")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deploymentId\": 123,\n  \"creatorMode\": true,\n  \"email\": \"<string>\",\n  \"embedTenantName\": \"<string>\",\n  \"embedTenantProfile\": {\n    \"displayName\": \"<string>\"\n  },\n  \"embedTheme\": {\n    \"analyticsChat\": {\n      \"backgroundColor\": \"<string>\",\n      \"chatInput\": {\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\"\n      }\n    },\n    \"chat\": {\n      \"inputColor\": \"<string>\"\n    },\n    \"font\": \"<string>\",\n    \"primaryColor\": \"<string>\"\n  },\n  \"externalId\": \"<string>\",\n  \"groupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"internalId\": \"<string>\",\n  \"isEphemeral\": true,\n  \"publicDashboardId\": \"<string>\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"securityContext\": {},\n  \"settings\": {\n    \"showDashboardChat\": true\n  },\n  \"tenantGroupDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"tenantGroups\": [\n    \"<string>\"\n  ],\n  \"userAttributeDefinitions\": [\n    {\n      \"name\": \"<string>\",\n      \"defaultValue\": \"<string>\",\n      \"description\": \"<string>\",\n      \"displayName\": \"<string>\"\n    }\n  ],\n  \"userAttributes\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"userProfile\": {\n    \"displayName\": \"<string>\",\n    \"picture\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "sessionId": "<string>"
}

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Body

application/json

GenerateSessionDTO

deploymentId · number · required

creatorMode · boolean | null

email · string | null

embedTenantName · string | null

Pattern: ^[a-z][a-z0-9-]{0,34}[a-z0-9]$

embedTenantProfile · object | null

Show child attributes

embedTheme · object | null

Show child attributes

externalId · string | null

groupDefinitions · object[] | null · deprecated

Deprecated and ignored. Global groups can no longer be created through this endpoint — define them beforehand via the Cube Cloud UI or admin API. Still accepted for backward compatibility (no error), but it has no effect. To create per-embed-tenant groups, use tenantGroupDefinitions.

Show child attributes

groups · string[] | null

Global user groups — defined once at the tenant level and shared across every embed tenant — to assign this embed user to. Use groups for data-model access control: each name is placed verbatim into the Cube security context as cubeCloud.groups, where your data model's access_policy rules reference it to gate cubes, views, members, and row-/column-level filters. The groups must already exist in the tenant (create them via the Cube Cloud UI or admin API beforehand) — this endpoint never creates global groups, and names that do not resolve to an existing group are rejected. Global groups are NOT shown in an embed tenant’s Creator Mode UI. To share or organize content inside a single embed tenant, use tenantGroups instead.

internalId · string | null

isEphemeral · boolean | null

publicDashboardId · string | null

roles · string[] | null

securityContext · object | null

settings · object | null

Per-session overrides for embed behavior. Each key is tri-state: omit it to inherit the account-wide setting, or set true/false to force the behavior for every embed viewed with this session, taking precedence over the account-wide setting.

Show child attributes

tenantGroupDefinitions · object[] | null

Idempotently create or update the per-embed-tenant groups referenced by tenantGroups, before they are assigned. Requires creatorMode: true and embedTenantName. Use this to declare a tenant’s groups in the same call that assigns them, so you do not need a separate admin request. Applies only to per-embed-tenant groups; global groups must be defined beforehand.

Show child attributes

tenantGroups · string[] | null

Per-embed-tenant user groups — scoped to the single embed tenant named by embedTenantName — to assign this embed user to. Use tenantGroups for content sharing and organization within one embed tenant: for example, so a creator can share a workbook, dashboard, or folder with a group of that tenant’s users. These are the only groups shown in the embed tenant’s Creator Mode UI. Requires creatorMode: true and embedTenantName. Define the groups beforehand — or in the same request — via tenantGroupDefinitions. In the Cube security context they appear namespaced as system:tenant:{embedTenantName}:group:{groupName}, so a tenant group can never collide with — or be mistaken for — a global groups entry of the same name. For organization-wide data-model access policies, use groups.

userAttributeDefinitions · object[] | null

Show child attributes

userAttributes · object[] | null

Show child attributes

userProfile · object | null

Show child attributes

Response

200 - application/json

sessionId · string · required