Skip to main content
POST
Generate embedded SSO session

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
externalId
string
required

External identifier for the user, from your system.

Example:

"user-123"

name
string
required

Display name for the user

Example:

"Blob Ross"

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:
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.

Example:

Response

Session token generated

sessionId
string
required

Session ID to use for embedding Omni content