OMomni
Embed

Generate embedded SSO session

Changed on
<Note> The [Embed](/embed) feature must be enabled in your Omni organization to use this endpoint. </Note>

Generate an embedded SSO session.

post/v1/embed/sso/generate-session

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/embed/sso/generate-session
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

connectionRolesobject

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.

customThemeobject

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

groupsstring[]

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

modelRolesobject

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.

sdkstring

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

signaturestring

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

userAttributesobject

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.

Example request

{
  "connectionRoles": {
    "65b10d2a-473b-4486-92c8-0ba628c7d1cb": "RESTRICTED_QUERIER"
  },
  "groups": [
    "engineering",
    "sales"
  ],
  "userAttributes": {
    "account_id": "9007199254740993",
    "region": "us-east",
    "tier": 2
  }
}

Response

Session token generated

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

sessionIdstring required

Session ID to use for embedding Omni content

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

Changes