Generate embedded SSO session

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/embed/sso/generate-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contentPath": "/my",
  "externalId": "user-123",
  "name": "Blob Ross",
  "accessBoost": true,
  "branch": "<string>",
  "connectionRoles": {
    "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER"
  },
  "customTheme": {},
  "customThemeId": "<string>",
  "email": "<string>",
  "entity": "<string>",
  "entityAiCreditLimit": "<string>",
  "entityFolderGroupContentRole": "VIEWER",
  "entityFolderLabel": "<string>",
  "entityGroupLabel": "<string>",
  "filterSearchParam": "<string>",
  "groups": [
    "engineering",
    "sales"
  ],
  "linkAccess": "<string>",
  "modelRoles": {},
  "nonce": "<string>",
  "sdk": "<string>",
  "signature": "<string>",
  "timezone": "<string>",
  "uiSettings": {
    "showNavigation": true,
    "dashboardChartContextMenu": true,
    "dashboardGeneratedAt": true,
    "tileRanTimestamp": true,
    "showHeader": true,
    "shareButton": true
  },
  "userAttributes": {
    "account_id": "9007199254740993",
    "region": "us-east",
    "tier": 2
  }
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/embed/sso/generate-session"

payload = {
    "contentPath": "/my",
    "externalId": "user-123",
    "name": "Blob Ross",
    "accessBoost": True,
    "branch": "<string>",
    "connectionRoles": { "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER" },
    "customTheme": {},
    "customThemeId": "<string>",
    "email": "<string>",
    "entity": "<string>",
    "entityAiCreditLimit": "<string>",
    "entityFolderGroupContentRole": "VIEWER",
    "entityFolderLabel": "<string>",
    "entityGroupLabel": "<string>",
    "filterSearchParam": "<string>",
    "groups": ["engineering", "sales"],
    "linkAccess": "<string>",
    "modelRoles": {},
    "nonce": "<string>",
    "sdk": "<string>",
    "signature": "<string>",
    "timezone": "<string>",
    "uiSettings": {
        "showNavigation": True,
        "dashboardChartContextMenu": True,
        "dashboardGeneratedAt": True,
        "tileRanTimestamp": True,
        "showHeader": True,
        "shareButton": True
    },
    "userAttributes": {
        "account_id": "9007199254740993",
        "region": "us-east",
        "tier": 2
    }
}
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({
    contentPath: '/my',
    externalId: 'user-123',
    name: 'Blob Ross',
    accessBoost: true,
    branch: '<string>',
    connectionRoles: {'65b10d2a-473b-4486-92c8-0ba628c7d1cb': 'RESTRICTED_QUERIER'},
    customTheme: {},
    customThemeId: '<string>',
    email: '<string>',
    entity: '<string>',
    entityAiCreditLimit: '<string>',
    entityFolderGroupContentRole: 'VIEWER',
    entityFolderLabel: '<string>',
    entityGroupLabel: '<string>',
    filterSearchParam: '<string>',
    groups: ['engineering', 'sales'],
    linkAccess: '<string>',
    modelRoles: {},
    nonce: '<string>',
    sdk: '<string>',
    signature: '<string>',
    timezone: '<string>',
    uiSettings: {
      showNavigation: true,
      dashboardChartContextMenu: true,
      dashboardGeneratedAt: true,
      tileRanTimestamp: true,
      showHeader: true,
      shareButton: true
    },
    userAttributes: {account_id: '9007199254740993', region: 'us-east', tier: 2}
  })
};

fetch('https://{instance}.omniapp.co/api/v1/embed/sso/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://{instance}.omniapp.co/api/v1/embed/sso/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([
    'contentPath' => '/my',
    'externalId' => 'user-123',
    'name' => 'Blob Ross',
    'accessBoost' => true,
    'branch' => '<string>',
    'connectionRoles' => [
        '65b10d2a-473b-4486-92c8-0ba628c7d1cb' => 'RESTRICTED_QUERIER'
    ],
    'customTheme' => [
        
    ],
    'customThemeId' => '<string>',
    'email' => '<string>',
    'entity' => '<string>',
    'entityAiCreditLimit' => '<string>',
    'entityFolderGroupContentRole' => 'VIEWER',
    'entityFolderLabel' => '<string>',
    'entityGroupLabel' => '<string>',
    'filterSearchParam' => '<string>',
    'groups' => [
        'engineering',
        'sales'
    ],
    'linkAccess' => '<string>',
    'modelRoles' => [
        
    ],
    'nonce' => '<string>',
    'sdk' => '<string>',
    'signature' => '<string>',
    'timezone' => '<string>',
    'uiSettings' => [
        'showNavigation' => true,
        'dashboardChartContextMenu' => true,
        'dashboardGeneratedAt' => true,
        'tileRanTimestamp' => true,
        'showHeader' => true,
        'shareButton' => true
    ],
    'userAttributes' => [
        'account_id' => '9007199254740993',
        'region' => 'us-east',
        'tier' => 2
    ]
  ]),
  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://{instance}.omniapp.co/api/v1/embed/sso/generate-session"

	payload := strings.NewReader("{\n  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\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://{instance}.omniapp.co/api/v1/embed/sso/generate-session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/embed/sso/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  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\n  }\n}"

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

{
  "membershipId": "<string>",
  "sessionId": "<string>",
  "userId": "<string>"
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

POST

embed

sso

generate-session

Generate embedded SSO session

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/embed/sso/generate-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contentPath": "/my",
  "externalId": "user-123",
  "name": "Blob Ross",
  "accessBoost": true,
  "branch": "<string>",
  "connectionRoles": {
    "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER"
  },
  "customTheme": {},
  "customThemeId": "<string>",
  "email": "<string>",
  "entity": "<string>",
  "entityAiCreditLimit": "<string>",
  "entityFolderGroupContentRole": "VIEWER",
  "entityFolderLabel": "<string>",
  "entityGroupLabel": "<string>",
  "filterSearchParam": "<string>",
  "groups": [
    "engineering",
    "sales"
  ],
  "linkAccess": "<string>",
  "modelRoles": {},
  "nonce": "<string>",
  "sdk": "<string>",
  "signature": "<string>",
  "timezone": "<string>",
  "uiSettings": {
    "showNavigation": true,
    "dashboardChartContextMenu": true,
    "dashboardGeneratedAt": true,
    "tileRanTimestamp": true,
    "showHeader": true,
    "shareButton": true
  },
  "userAttributes": {
    "account_id": "9007199254740993",
    "region": "us-east",
    "tier": 2
  }
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/embed/sso/generate-session"

payload = {
    "contentPath": "/my",
    "externalId": "user-123",
    "name": "Blob Ross",
    "accessBoost": True,
    "branch": "<string>",
    "connectionRoles": { "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER" },
    "customTheme": {},
    "customThemeId": "<string>",
    "email": "<string>",
    "entity": "<string>",
    "entityAiCreditLimit": "<string>",
    "entityFolderGroupContentRole": "VIEWER",
    "entityFolderLabel": "<string>",
    "entityGroupLabel": "<string>",
    "filterSearchParam": "<string>",
    "groups": ["engineering", "sales"],
    "linkAccess": "<string>",
    "modelRoles": {},
    "nonce": "<string>",
    "sdk": "<string>",
    "signature": "<string>",
    "timezone": "<string>",
    "uiSettings": {
        "showNavigation": True,
        "dashboardChartContextMenu": True,
        "dashboardGeneratedAt": True,
        "tileRanTimestamp": True,
        "showHeader": True,
        "shareButton": True
    },
    "userAttributes": {
        "account_id": "9007199254740993",
        "region": "us-east",
        "tier": 2
    }
}
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({
    contentPath: '/my',
    externalId: 'user-123',
    name: 'Blob Ross',
    accessBoost: true,
    branch: '<string>',
    connectionRoles: {'65b10d2a-473b-4486-92c8-0ba628c7d1cb': 'RESTRICTED_QUERIER'},
    customTheme: {},
    customThemeId: '<string>',
    email: '<string>',
    entity: '<string>',
    entityAiCreditLimit: '<string>',
    entityFolderGroupContentRole: 'VIEWER',
    entityFolderLabel: '<string>',
    entityGroupLabel: '<string>',
    filterSearchParam: '<string>',
    groups: ['engineering', 'sales'],
    linkAccess: '<string>',
    modelRoles: {},
    nonce: '<string>',
    sdk: '<string>',
    signature: '<string>',
    timezone: '<string>',
    uiSettings: {
      showNavigation: true,
      dashboardChartContextMenu: true,
      dashboardGeneratedAt: true,
      tileRanTimestamp: true,
      showHeader: true,
      shareButton: true
    },
    userAttributes: {account_id: '9007199254740993', region: 'us-east', tier: 2}
  })
};

fetch('https://{instance}.omniapp.co/api/v1/embed/sso/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://{instance}.omniapp.co/api/v1/embed/sso/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([
    'contentPath' => '/my',
    'externalId' => 'user-123',
    'name' => 'Blob Ross',
    'accessBoost' => true,
    'branch' => '<string>',
    'connectionRoles' => [
        '65b10d2a-473b-4486-92c8-0ba628c7d1cb' => 'RESTRICTED_QUERIER'
    ],
    'customTheme' => [
        
    ],
    'customThemeId' => '<string>',
    'email' => '<string>',
    'entity' => '<string>',
    'entityAiCreditLimit' => '<string>',
    'entityFolderGroupContentRole' => 'VIEWER',
    'entityFolderLabel' => '<string>',
    'entityGroupLabel' => '<string>',
    'filterSearchParam' => '<string>',
    'groups' => [
        'engineering',
        'sales'
    ],
    'linkAccess' => '<string>',
    'modelRoles' => [
        
    ],
    'nonce' => '<string>',
    'sdk' => '<string>',
    'signature' => '<string>',
    'timezone' => '<string>',
    'uiSettings' => [
        'showNavigation' => true,
        'dashboardChartContextMenu' => true,
        'dashboardGeneratedAt' => true,
        'tileRanTimestamp' => true,
        'showHeader' => true,
        'shareButton' => true
    ],
    'userAttributes' => [
        'account_id' => '9007199254740993',
        'region' => 'us-east',
        'tier' => 2
    ]
  ]),
  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://{instance}.omniapp.co/api/v1/embed/sso/generate-session"

	payload := strings.NewReader("{\n  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\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://{instance}.omniapp.co/api/v1/embed/sso/generate-session")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/embed/sso/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  \"contentPath\": \"/my\",\n  \"externalId\": \"user-123\",\n  \"name\": \"Blob Ross\",\n  \"accessBoost\": true,\n  \"branch\": \"<string>\",\n  \"connectionRoles\": {\n    \"65b10d2a-473b-4486-92c8-0ba628c7d1cb\": \"RESTRICTED_QUERIER\"\n  },\n  \"customTheme\": {},\n  \"customThemeId\": \"<string>\",\n  \"email\": \"<string>\",\n  \"entity\": \"<string>\",\n  \"entityAiCreditLimit\": \"<string>\",\n  \"entityFolderGroupContentRole\": \"VIEWER\",\n  \"entityFolderLabel\": \"<string>\",\n  \"entityGroupLabel\": \"<string>\",\n  \"filterSearchParam\": \"<string>\",\n  \"groups\": [\n    \"engineering\",\n    \"sales\"\n  ],\n  \"linkAccess\": \"<string>\",\n  \"modelRoles\": {},\n  \"nonce\": \"<string>\",\n  \"sdk\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"uiSettings\": {\n    \"showNavigation\": true,\n    \"dashboardChartContextMenu\": true,\n    \"dashboardGeneratedAt\": true,\n    \"tileRanTimestamp\": true,\n    \"showHeader\": true,\n    \"shareButton\": true\n  },\n  \"userAttributes\": {\n    \"account_id\": \"9007199254740993\",\n    \"region\": \"us-east\",\n    \"tier\": 2\n  }\n}"

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

{
  "membershipId": "<string>",
  "sessionId": "<string>",
  "userId": "<string>"
}

{
  "detail": "<string>",
  "status": 400
}

{
  "detail": "Unauthorized: Missing or invalid API key",
  "status": 401
}

{
  "detail": "<string>",
  "status": 403
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json

contentPath

string

required

Path to the Omni content to open, such as /dashboards/abc123. See the contentPath parameter reference for valid starting pages.

Minimum string length: 1

Example:

"/my"

externalId

string

required

External identifier for the user, from your system. Cannot be empty. See the externalId parameter reference for more information.

Minimum string length: 1

Example:

"user-123"

name

string

required

Display name for the user. Cannot be empty. See the name parameter reference for more information.

Minimum string length: 1

Example:

"Blob Ross"

accessBoost

If true, enables AccessBoost for the embedded dashboard. Requires AccessBoost to be enabled for non-administrators in Settings > Content permissions.

Available options:

true,

false

Example:

true

branch

string

Accepted for compatibility. This endpoint does not apply the branch to the session.

connectionRoles

object

Map of connection IDs to base or custom role names, setting the level of access embed users have to the connection's models. Invalid or disallowed roles are ignored. See the connectionRoles parameter reference for accepted role values and omission behavior.

Show child attributes

Example:

{
  "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER"
}

customTheme

object

Custom dashboard theme properties. Values must be a valid theme property. See the customTheme parameter reference for more information.

Show child attributes

customThemeId

string

The ID of a saved dashboard theme. See the customThemeId parameter reference for more information.

string

Optional embed user email address. An empty string is treated as omitted; non-empty values must be email-shaped. See the email parameter reference for its effect on existing email-only users.

entity

string

Alphanumeric identifier for the user group, used to associate the embed user with a shared entity folder. See the entity parameter reference for more information.

Maximum string length: 64

entityAiCreditLimit

string

Requires entity. The AI credit cap for the specified entity. Send a non-negative number as a string, or unlimited (case-insensitive). An empty string is treated as omitted.

See the entityAiCreditLimit parameter reference for more information.

entityFolderContentRole

enum<string>

Content role for the embed user's shared entity folder. See the entityFolderContentRole parameter reference for role definitions.

Available options:

MANAGER,

EDITOR,

VIEWER,

NO_ACCESS

entityFolderGroupContentRole

enum<string>

default:VIEWER

Content role for the entity group's shared entity folder. Defaults to VIEWER if unspecified. See the entityFolderGroupContentRole parameter reference for more information.

Available options:

MANAGER,

EDITOR,

VIEWER,

NO_ACCESS

entityFolderLabel

string

Requires entity. Label for the embed user's entity folder. See the entityFolderLabel parameter reference for more information.

Maximum string length: 64

entityGroupLabel

string

Requires entity. Label for the embed entity group. See the entityGroupLabel parameter reference for more information.

Maximum string length: 64

filterSearchParam

string

Filter URL search parameter to add to the contentPath. See the filterSearchParam parameter reference for the value format.

groups

string[]

Optional list of non-entity group names to assign to the user. Entity-group membership is managed by the entity URL parameter.

Example:

["engineering", "sales"]

linkAccess

string

Level of link access for the embed user. See the linkAccess parameter reference for accepted values.

mode

enum<string>

Access mode for the embed session:

APPLICATION enables Create mode
SINGLE_CONTENT embeds a single dashboard, workbook, or app

See the mode parameter reference for more information.

Available options:

APPLICATION,

SINGLE_CONTENT

modelRoles

object

Map of model IDs to base or custom role names, overriding connectionRoles. Invalid or disallowed roles are ignored. See the modelRoles parameter reference for more information.

Show child attributes

nonce

string

Accepted for compatibility, but not used by this endpoint. Replay protection applies to signed-URL login instead. See the nonce parameter reference for more information.

Required string length: 32

preserveEntityFolderContentRole

If true, retains the embed user's existing entity folder content role instead of applying the role from this request. See the preserveEntityFolderContentRole parameter reference for more information.

Available options:

true,

false

sdk

string

Optional SDK telemetry marker used for Omni's internal tracking. Has no effect on the created session.

Maximum string length: 64

signature

string

Accepted for compatibility, but this endpoint authenticates with an Organization API key, not this signature.

Minimum string length: 32

timezone

string

Accepted for compatibility, but this endpoint does not apply the timezone to the session. See the timezone parameter reference, which applies to signed-URL embed login instead.

uiSettings

object

Embed UI settings. Invalid values are ignored. See the uiSettings parameter reference for more information.

Show child attributes

userAttributes

object

Optional user attributes for row-level security. Values are a string, a number, or an array of strings/numbers. Numbers are converted to strings on receipt, so send anything beyond the JSON safe integer range (2^53 - 1) as a string or it loses precision before Omni sees it.

See the userSettings parameter reference for more information.

Show child attributes

Example:

{
  "account_id": "9007199254740993",
  "region": "us-east",
  "tier": 2
}

Response

Session token generated

membershipId

string

required

Membership ID of the embed user the session logs in as. This is the same ID used by the List and retrieve embed users endpoints.

sessionId

string

required

Session ID to use for embedding Omni content

userId

string

required

Omni user ID of the embed user the session logs in as. This ID is created on the user's first request with a given externalId, and reused on later requests.

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Generate embedded SSO session

Authorizations

Body

Response