Skip to main content
POST
Generate an embed session

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]$
embedTheme
object | null
ephemeralTtlSeconds
number | null
externalId
string | null
groupDefinitions
object[] | null
groups
string[] | null
internalId
string | null
isEphemeral
boolean | null
publicDashboardId
string | null
roles
string[] | null
securityContext
object | null
userAttributeDefinitions
object[] | null
userAttributes
object[] | null
userProfile
object | null

Response

200 - application/json
sessionId
string
required