Generate an embed session
π 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.
Creates a one-time embed session for a deployment and returns its sessionId.
The session captures the embed context that will be baked into the embed token once redeemed β the target deploymentId, the end userβs identity (externalId / email / userProfile), their groups and userAttributes, and an optional securityContext. Exchange the returned sessionId for a signed embed JWT via POST /api/v1/embed/session/token (single use).
deploymentId is required and the caller must have read access to it. Embedding must be enabled for the tenant, otherwise 403 is returned.
Authorizations
API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.
Body
GenerateSessionDTO
^[a-z][a-z0-9-]{3,34}[a-z0-9]$