v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Embed

Generate embedded SSO session

post/api/v1/embed/sso/generate-session

Request body

externalIdstring required

External identifier for the user (from your system)

groupsstring[]

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

namestring required

Display name for the user

userAttributesobject

Optional user attributes for row-level security

Example request

{
  "externalId": "user-123",
  "groups": [
    "engineering",
    "sales"
  ],
  "name": "John Doe"
}

Response

Session token generated

sessionIdstring required

Session ID to use for embedding Omni content