Skip to main content
Organization Admin permissions are required to follow the steps in this guide.
1

Contact Omni support

First, reach out to Omni support to have the Embed feature enabled for your instance.
2

Set up session generation

You have two options when it comes to generating embedded user sessions:
  1. Standard SSO: Generate and use a single URL to create an embed user and session. This is the simplest way to embed Omni for your external users.
  2. 2-step SSO: First, send a POST request to generate the embed user and session. Then, generate and use a URL to authenticate into the session. This requires more setup, but has a few advantages over the standard SSO embed experience:
    • Sensitive user data: If using the userAttributes parameter with sensitive user data, you may prefer creating SSO embed users and sessions via POST request for added security.
    • URL length: While generally unlikely, there is more risk of standard SSO embed URLs exceeding a browser’s URL character limit. 2-step login URLs are more compact and thus have no risk of hitting the limit.
Follow the guide for your preferred approach to complete the implementation.
While Omni is where permissions and content are managed, the application where the content is embedded should dynamically map users to the right underlying data. Refer to the Embedding best practices to make sure Omni is set up correctly before you begin developing.
3

Customize your application

Once you successfully set up your embed infrastructure, you can: