Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.
With standard SSO, you generate and use a single URL to create an embed user and session. Omni embed URLs are signed with a secret key used only by your organization. When an Omni server receives the request, it verifies the signature using that secret. If the signature checks out, the request is honored.Two signing formats are supported for standard SSO:
Every parameter is included inside a single payload query parameter that the signature covers as a whole. If generating with the SDK, requires @omni-co/embed v1.0.0 or later.
Each parameter is sent as its own query parameter alongside a signature. Deprecated: unsupported after October 1, 2026, and removed by January 1, 2027.
Both formats are accepted at /embed/login, so existing integrations will continue to work. Use v1 for new integrations, and plan to migrate existing ones.
Because embed URLs are signed using your Omni organization’s embed secret, it is crucial that your embed URLs are generated server-side rather than client-side. From a security perspective, this protects your embed secret from being exposed to attackers.Also note that the Omni TypeScript SDK utilizes Node’s crypto module, which is only available in Node environments. Attempting to use the Omni TypeScript SDK functions in a client-side context will likely lead to the SDK functions generating improperly signed embed URLs.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Omni Docs","colors":{"primary":"#FF5FA2","light":"#FF5FA2","dark":"#4D122C"},"logo":{"light":"https://mintcdn.com/omni-e7402367/m1fg0tfdkEcnYhky/images/logo/omni-black.png?fit=max\u0026auto=format\u0026n=m1fg0tfdkEcnYhky\u0026q=85\u0026s=85b81b605382b15b60eb75159899002a","dark":"https://mintcdn.com/omni-e7402367/m1fg0tfdkEcnYhky/images/logo/omni-white.png?fit=max\u0026auto=format\u0026n=m1fg0tfdkEcnYhky\u0026q=85\u0026s=18b529bed326b4f1be9d58ac65b9e002"},"favicon":"https://mintcdn.com/omni-e7402367/WTWdmWXPOMD5jOUY/favicon.png?fit=max\u0026auto=format\u0026n=WTWdmWXPOMD5jOUY\u0026q=85\u0026s=775ee4acbc06107599e3471e50161a2b","background":{"color":{"light":"#FCFCF7","dark":"#0e0b0e"}},"navbar":{"links":[{"href":"https://community.omni.co","label":"Community"}],"primary":{"type":"button","label":"Try Omni!","href":"https://omni.co/demo"}},"footer":{},"seo":{"metatags":{"canonical":"https://docs.omni.co"}},"fonts":{"heading":{"family":"Cal Sans","weight":400},"body":{"family":"IBM Plex Sans"}},"integrations":{"ga4":{"measurementId":"G-ZMG0QT2W9L"}},"banner":{"content":"Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the [Omni Agent](/ai/chat) in the sidebar.","dismissible":true},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/omni-e7402367/J1q2UvTSjLHOwJ3G/images/og/og-background.png?fit=max\u0026auto=format\u0026n=J1q2UvTSjLHOwJ3G\u0026q=85\u0026s=63ad1c86bdbf4da4196959c391afb21f","fonts":{"family":"IBM Plex Sans"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omni-e7402367","hasAudioNarration":false,"actualSubdomain":"omni-e7402367","customDomains":["docs.omni.co"],"gitSource":{"type":"github","owner":"exploreomni","repo":"mintlify-omni","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae354d19ee4546ca4eb153f","collectionId":"0f35af83-4736-4a07-8dfd-d85dcd0172b0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae354d19ee4546ca4eb153f"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae37d523705bfd3e16bfcba","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Docs","count":502},{"language":"default","tag":"Developers","count":376},{"language":"default","tag":"Model data","count":302},{"language":"default","tag":"REST APIs","count":253},{"language":"default","tag":"Parameters","count":187},{"language":"default","tag":"Product updates","count":159},{"language":"default","tag":"Demos","count":155},{"language":"default","tag":"Admin","count":122},{"language":"default","tag":"Visualize \u0026 present","count":99},{"language":"default","tag":"Embedding","count":85}],"searchSettings":{"isFiltersEnabled":true,"maxResults":10}},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":"img{border:1px solid;border-color:rgb(var(--gray-200))}.nav-logo,.no-border{border:0}#banner{color:#fcfcf7;font-weight:600}#topbar-cta-button,[data-testid=rss-feed-button]{transition:background-color .2s ease,transform .1s ease}#topbar-cta-button{background-color:#ff5fa2;padding:0;border-radius:160px;text-decoration:none;font-weight:800;cursor:pointer}#topbar-cta-button span{background-color:transparent!important}#topbar-cta-button>a{padding:8px 14px!important}#topbar-cta-button,#topbar-cta-button *{color:#fcfcf7!important}#topbar-cta-button:hover{background-color:#ff5fa2;transform:translateY(-1px)}#topbar-cta-button:active{transform:translateY(0)}#topbar-cta-button svg{display:none!important}.navbar-link a{border-radius:160px!important}.dark .navbar-link a{background-color:rgb(255 255 255/.1)!important}.dark .navbar-link a:hover{background-color:rgb(255 255 255/.2)!important}[data-testid=rss-feed-button]{border-color:#ff5fa2!important;color:#ff5fa2!important;border-radius:160px!important;gap:6px}[data-testid=rss-feed-button]::after{content:\"Subscribe\";font-size:14px;font-weight:600}[data-testid=rss-feed-button] svg{stroke:#ff5fa2}[data-testid=rss-feed-button]:hover{background-color:rgba(255,95,162,.05)!important;transform:translateY(-1px)}.dark [data-testid=rss-feed-button]:hover{background-color:rgba(255,95,162,.1)!important}[class*=cursor-copy][class*=max-h-]{max-height:20px!important}:has(>.guide-header){position:relative;max-width:1100px;margin:0 auto;padding:24px 24px 72px calc(200px + 48px + 24px);color:rgb(var(--gray-700))}.dark :has(>.guide-header){color:rgb(var(--gray-400))}.guide-header{position:sticky;top:var(--scroll-mt, 9.5rem);z-index:20;background-color:#fcfcf7;padding:0 0 1px;margin-bottom:35px;box-shadow:0 -10rem 0 10rem #fcfcf7}.dark .guide-header{background-color:#0e0b0e;box-shadow:0 -10rem 0 10rem #0e0b0e}.guide-title{font-size:2.5rem;font-weight:700;color:rgb(var(--gray-900));margin:0;line-height:1.3}.dark .guide-title{color:rgb(var(--gray-50))}.guide-sidebar{position:absolute;left:24px;top:24px;bottom:0;width:200px}.guide-sidebar-content{position:sticky;top:calc(var(--scroll-mt, 9.5rem) + 10px)}.guide-sidebar-back{display:flex;align-items:center;gap:8px;color:rgb(var(--gray-500));text-decoration:none;font-size:14px;font-weight:500;margin-bottom:24px;transition:color .15s ease}.guide-sidebar-back:hover,.guide-sidebar-links a{color:rgb(var(--primary))}.guide-sidebar-section{margin-bottom:20px}.guide-sidebar-label{font-size:11px;font-weight:600;text-transform:uppercase;letter-spacing:.05em;color:rgb(var(--gray-500));margin-bottom:6px}.guide-sidebar-category{display:flex;align-items:center;gap:6px;font-size:14px;color:rgb(var(--gray-700));text-transform:capitalize}.dark .guide-sidebar-category{color:rgb(var(--gray-300))}.guide-sidebar-date{font-size:14px;color:rgb(var(--gray-600))}.dark .guide-sidebar-date,.dark .guide-sidebar-progress-text{color:rgb(var(--gray-400))}.guide-sidebar-links{list-style:none;padding:0;margin:0}.guide-sidebar-links li{margin-bottom:6px}.guide-sidebar-progress{display:flex;align-items:center;gap:12px}.guide-mascot{flex-shrink:0}.guide-mascot svg{display:block}.guide-sidebar-progress-text{font-size:14px;font-weight:600;color:rgb(var(--gray-600))}.guide-sidebar-links a{font-size:14px;text-decoration:none}:has(>.guide-header) .guide-sidebar a{border-bottom:none;font-weight:inherit}:has(>.guide-header) a.guide-sidebar-back{color:rgb(var(--gray-500));font-weight:500}:has(>.guide-header) .guide-sidebar-links a,:has(>.guide-header) a.guide-sidebar-back:hover{color:rgb(var(--primary))}:has(>.guide-header) .guide-sidebar-links a:hover{text-decoration:underline}@media (max-width:768px){:has(>.guide-header){padding:24px 24px 72px}.guide-sidebar{position:static;width:100%;margin-bottom:24px}.guide-sidebar-content{position:static;display:flex;flex-wrap:wrap;align-items:center;gap:12px}.guide-sidebar-back{width:100%;margin-bottom:4px}.guide-sidebar-section{margin-bottom:0}.guide-sidebar-section:has(.guide-sidebar-links),.guide-sidebar-section:has(.guide-sidebar-progress){display:none}.guide-sidebar-label{display:none}.guide-sidebar-category,.guide-sidebar-date{font-size:12px;padding:4px 10px;border-radius:4px;background-color:#f1f5f9;color:#1e191a}.dark .guide-sidebar-category,.dark .guide-sidebar-date{background-color:rgba(255,255,255,.03);color:#faf5f7}.guide-header{position:static;box-shadow:none}.guide-sticky-header{padding:12px 16px}.guide-progress-track{margin:-12px -16px 12px}.guide-sticky-title{font-size:1.5rem}}:has(>.guide-header) h1,:has(>.guide-header) h2,:has(>.guide-header) h3{color:rgb(var(--gray-900))}.dark :has(>.guide-header) a,.dark :has(>.guide-header) h1,.dark :has(>.guide-header) h2,.dark :has(>.guide-header) h3,.dark :has(>.guide-header) strong{color:rgb(var(--gray-50))}:has(>.guide-header) h1{font-size:2.25rem;margin:0 0 16px}:has(>.guide-header) h2{font-size:1.5rem;font-weight:600;margin:32px 0 16px;line-height:1.3}:has(>.guide-header) [data-component-part=step-title]{margin:0 0 16px}:has(>.guide-header) h3{font-size:1.25rem;font-weight:600;margin:24px 0 12px;line-height:1.4}:has(>.guide-header) [data-as=p],:has(>.guide-header) p{display:block;margin:16px 0;line-height:1.7}:has(>.guide-header)>.guide-header+[data-as=p],:has(>.guide-header)>.guide-header+p{margin-top:0}:has(>.guide-header) ol:not(.not-prose),:has(>.guide-header) ul:not(.not-prose){margin:16px 0;padding-left:24px}:has(>.guide-header) ul:not(.not-prose){list-style-type:disc}:has(>.guide-header) ol:not(.not-prose){list-style-type:decimal!important}:has(>.guide-header) :not(.not-prose)>li{margin-bottom:8px;line-height:1.6}:has(>.guide-header) .prose ul:not(.not-prose){list-style-type:none;padding-left:0}:has(>.guide-header) .prose :not(.not-prose)>li{margin-bottom:0}:has(>.guide-header) a{color:#111827;text-decoration:none;font-weight:600;border-bottom:1px solid rgb(var(--primary))}:has(>.guide-header) a:hover{border-bottom-width:2px}:has(>.guide-header) strong,:has(>.guide-header) th{font-weight:600;color:rgb(var(--gray-900))}:has(>.guide-header) code{font-size:.9em}:has(>.guide-header) table{width:100%;border-collapse:collapse;margin:16px 0}:has(>.guide-header) th{text-align:left;padding:8px 16px 8px 0;border-bottom:1px solid rgb(var(--gray-200))}.dark :has(>.guide-header) th{color:rgb(var(--gray-50))}:has(>.guide-header) td{padding:12px 16px 12px 0;border-bottom:1px solid rgb(var(--gray-200));vertical-align:top}.dark :has(>.guide-header) td,.dark :has(>.guide-header) th{border-bottom-color:rgb(var(--gray-700))}:has(>.guide-header) img{margin:16px 0;border-radius:8px}:has(>.guide-header) [data-component-part=card-title]{font-size:1rem!important;margin:4px 0 0!important}:has(>.guide-header) [data-component-part=card-content]{font-size:.875rem!important;line-height:1.5!important}:has(>.guide-header) [data-component-part=card-content] [data-as=p]{font-size:.875rem!important;margin:4px 0!important;line-height:1.5!important}.guides-container{max-width:1200px;margin:0 auto;padding:48px 24px}.guides-title{font-size:2.5rem;font-weight:700;color:#1e191a;margin-bottom:16px}.dark .guides-title{color:#e6e1e2}.guides-description{font-size:1.125rem;color:#1e191a;margin-bottom:32px}.dark .guides-description,.dark .guides-filter-label{color:#cbd5e1}.guides-layout{display:flex;gap:48px}.guides-sidebar{width:220px;flex-shrink:0}.guides-filters{position:sticky;top:100px;max-height:calc(100vh - 124px);overflow-y:auto;scrollbar-width:thin}.guides-filters::-webkit-scrollbar{width:6px}.guides-filters::-webkit-scrollbar-thumb{background:rgba(128,128,128,.35);border-radius:3px}.guides-filter-group{margin-bottom:24px}.guides-filter-label{display:block;font-size:12px;font-weight:600;text-transform:uppercase;letter-spacing:.05em;color:#1e191a;margin-bottom:8px}.guides-filter-input{width:100%;padding:8px 12px;border-top-left-radius:9999px;border-top-right-radius:9999px;border-bottom-left-radius:9999px;border-bottom-right-radius:9999px;border-color:#e6e1e2;font-size:14px;box-sizing:border-box;background-color:rgba(17,12,14,.03);color:#777274}.dark .guides-filter-input{background-color:rgba(255,255,255,.03);border-color:#334155;color:rgba(255,255,255,.5)}.guides-filter-input:focus{outline:0;border-color:#ff5fa2}.dark .guides-filter-input::placeholder{color:rgba(255,255,255,.5)}.guides-clear-button,.guides-filter-button{width:100%;border:1px solid #e2e8f0;border-radius:160px;color:#334155;font-size:14px;cursor:pointer;transition:all .15s ease}.guides-filter-button{display:block;padding:8px 12px;margin-bottom:4px;background:0 0;text-align:left}.dark .guides-filter-button{color:#cbd5e1;border-color:rgba(255,255,255,.1);border-style:solid;border-width:1.5px}.guides-filter-button:hover{background-color:#f8fafc}.dark .guides-filter-button:hover{background-color:#0e0b0e;border-color:#ff5fa2}.guides-filter-button.active{border-color:#ff5fa2;background-color:#fff0f6;color:#ff5fa2}.dark .guides-filter-button.active{background-color:rgba(255,95,162,.15)}.guides-clear-button{padding:10px 12px;margin-bottom:16px;background:#f8fafc;font-weight:500}.dark .guides-clear-button{background:#0e0b0e;color:#e2e8f0;border-color:rgba(255,255,255,.1);border-style:solid;border-width:1.5px}.guides-clear-button:hover{background:#f1f5f9;border-color:#cbd5e1}.dark .guides-clear-button:hover{background:#0e0b0e;border-color:#ff5fa2}.guides-content{flex:1;min-width:0}.guides-results-count{font-size:14px;color:#1e191a;margin-bottom:16px}.dark .guides-results-count{color:#cbd5e1}.guides-grid{display:grid;grid-template-columns:repeat(auto-fill,minmax(280px,1fr));gap:16px}.guides-card{border:1px solid #e2e8f0;border-radius:16px;padding:20px;text-decoration:none;color:inherit;display:flex;flex-direction:column;gap:12px;transition:border-color .15s ease,box-shadow .15s ease;background-color:#fcfcf7}.dark .guides-card{border-color:rgba(255,255,255,.1);border-style:solid;border-width:1.5px;background-color:#0e0b0e}.guides-card:hover{border-color:#ff5fa2;box-shadow:0 2px 8px rgba(0,0,0,.08)}.dark .guides-card:hover{box-shadow:0 2px 8px rgba(0,0,0,.3)}.guides-card-icon{margin-bottom:4px}.guides-card-title{font-size:16px;font-weight:600;color:#1e191a;margin:0;line-height:1.3}.dark .guides-card-title{color:#fcfcf7}.guides-card-description{font-size:16px;color:#575254;margin:0;line-height:1.5;flex-grow:1}.dark .guides-card-description{color:#a6a1a2}.guides-card-meta{display:flex;align-items:center;gap:8px;flex-wrap:wrap}.guides-card-tag{font-size:12px;padding:2px 8px;border-radius:4px;background-color:#f1f5f9;color:#1e191a}.dark .guides-card-tag{background-color:rgba(255,255,255,.03);color:#faf5f7}.guides-no-results{text-align:center;padding:48px 24px;color:#1e191a}.dark .guides-no-results{color:#cbd5e1}@media (max-width:768px){.guides-layout{flex-direction:column;gap:24px}.guides-sidebar{width:100%}.guides-filters{position:static;max-height:none;overflow-y:visible}.guides-filter-button{display:inline-block;width:auto;margin-right:8px}}.badge-color{background-color:#ff5fa2;color:#fcfcf7!important}.lib-page{--lib-muted:#575254;color:#1e191a}.dark .lib-page{--lib-muted:#a6a1a2;color:#e6e1e2}.lib-page a{color:#ff5fa2}.lib-card:hover{border-color:#ff5fa2!important}.lib-panel{background-color:#fcfcf7;color:#1e191a}.dark .lib-panel{background-color:#0e0b0e;color:#e6e1e2}.lib-logo-chip{display:inline-flex;align-items:center;justify-content:center;flex:none;overflow:hidden}.dark .lib-logo-chip{padding:3px 5px;border-radius:5px;background-color:#fff}.lib-logo-chip img{border:0;border-radius:0}.endpoint-table{table-layout:fixed}.endpoint-table td:first-child,.endpoint-table th:first-child{width:18rem;min-width:18rem;max-width:18rem}.endpoint-table td:last-child,.endpoint-table th:last-child{width:8rem;min-width:8rem;max-width:8rem}.icon{border:0}.icons{background-color:#000}.dark .icons{background-color:rgb(var(--gray-50))}.icon-position{display:inline;vertical-align:middle}[data-component-part=accordion-icon] svg{display:block!important}.side-by-side{display:flex;flex-direction:row-reverse;align-items:flex-start;gap:1.5rem;margin:1.5rem 0}.side-by-side-reverse{flex-direction:row}.side-by-side-divider{padding-bottom:1.5rem;border-bottom:1px solid rgb(var(--gray-200))}.dark .side-by-side-divider{border-bottom-color:rgb(var(--gray-700))}.side-by-side-media{flex:0 0 45%;display:flex;flex-direction:column;align-items:center;margin:0}.side-by-side-media img{width:auto;height:auto;max-width:100%;max-height:var(--side-by-side-height, 220px);margin:0}.side-by-side-caption{margin-top:.75rem;padding:0 2rem .5rem;text-align:center;font-size:.875rem;line-height:1.25rem;color:rgb(var(--gray-700))}.dark .side-by-side-caption{color:rgb(var(--gray-400))}.side-by-side-body{flex:1;min-width:0}.side-by-side-body [data-as=p],.side-by-side-body p{display:block;margin:1rem 0}.side-by-side-body .side-by-side-title{margin:0 0 .5rem;font-weight:600;color:rgb(var(--gray-900))}.dark .side-by-side-body .side-by-side-title{color:rgb(var(--gray-50))}.side-by-side-body>:first-child{margin-top:0}.side-by-side-body>:last-child{margin-bottom:0}@media (max-width:768px){.side-by-side,.side-by-side-reverse{flex-direction:column;align-items:stretch}.side-by-side-media{flex:1 1 auto}}#page-title,.guides-title,:has(>.guide-header) h1{font-weight:400;line-height:1;letter-spacing:0;text-wrap:pretty}#page-title{font-size:2rem}@media (min-width:40rem){#page-title{font-size:2.625rem}}h2,h3,h4,h5,h6{font-family:var(--font-family-body-custom)}.mdx-content :is(h2, h3, h4, h5, h6):not([data-component-part]):not(.not-prose){font-weight:500;line-height:1.15;letter-spacing:0;text-wrap:pretty}.mdx-content h2:not([data-component-part]):not(.not-prose){font-size:1.5rem}"}],"page":{"pagePath":"embed/setup/standard-sso","slug":"/embed/setup/standard-sso","pageMetadata":{"title":"Embed standard SSO","sidebarTitle":"Overview","description":"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.","href":"/embed/setup/standard-sso/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Badge,Table,Warning}=_components;if(!Badge)_missingMdxReference(`Badge`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`With standard SSO, you generate and use a single URL to create an embed user and session. Omni embed URLs are signed with a secret key used only by your organization. When an Omni server receives the request, it verifies the signature using that secret. If the signature checks out, the request is honored.`}),`\n`,_jsx(_components.p,{children:`Two signing formats are supported for standard SSO:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Format`}),_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/embed/setup/standard-sso/latest`,children:_jsx(_components.strong,{children:`v1 (signed payload)`})})}),_jsx(_components.td,{children:_jsx(Badge,{color:`green`,children:`latest`})}),_jsxs(_components.td,{children:[`Every `,_jsx(_components.a,{href:`/embed/setup/url-parameters`,children:`parameter`}),` is included inside a single `,_jsx(_components.code,{children:`payload`}),` query parameter that the signature covers as a whole. If generating with the SDK, requires `,_jsx(_components.code,{children:`@omni-co/embed`}),` v1.0.0 or later.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/embed/setup/standard-sso/v0-legacy`,children:_jsx(_components.strong,{children:`v0 (legacy)`})})}),_jsx(_components.td,{children:_jsx(Badge,{color:`gray`,children:`v1 (deprecated)`})}),_jsxs(_components.td,{children:[`Each parameter is sent as its own query parameter alongside a `,_jsx(_components.code,{children:`signature`}),`. Deprecated: unsupported after October 1, 2026, and removed by January 1, 2027.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Both formats are accepted at `,_jsx(_components.code,{children:`/embed/login`}),`, so existing integrations will continue to work. Use v1 for new integrations, and plan to migrate existing ones.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:`Because embed URLs are signed using your Omni organization’s embed secret, it is crucial that your embed URLs are generated server-side rather than client-side. From a security perspective, this protects your embed secret from being exposed to attackers.`}),_jsxs(_components.p,{children:[`Also note that the Omni TypeScript SDK utilizes Node’s `,_jsx(_components.code,{children:`crypto`}),` module, which is only available in Node environments. Attempting to use the Omni TypeScript SDK functions in a client-side context will likely lead to the SDK functions generating improperly signed embed URLs.`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Embed standard SSO","sidebarTitle":"Overview","description":"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.","href":"/embed/setup/standard-sso/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"omni-e7402367","siteName":"Omni Docs","title":"Embed standard SSO - Omni Docs","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"manual"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-31T22:17:33.175Z","originalFileLocation":"embed/setup/standard-sso/index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Omni Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Embed standard SSO - Omni Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Omni Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.omni.co/embed/setup/standard-sso\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omni-e7402367.mintlify.app/_mintlify/api/og/v2?division=Standard+SSO\u0026amp;title=Embed+standard+SSO\u0026amp;description=Set+up+standard+SSO+for+Omni+embedding+by+generating+a+signed+URL+that+creates+an+embed+user+session+with+a+single+request.\u0026amp;theme=191f8a92cb0a982596561b95\u0026amp;signature=d411f6d006ea2f2f6659497b41ffe91f7bde9879430ad9d47326feeafc6159f2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Embed standard SSO - Omni Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omni-e7402367.mintlify.app/_mintlify/api/og/v2?division=Standard+SSO\u0026amp;title=Embed+standard+SSO\u0026amp;description=Set+up+standard+SSO+for+Omni+embedding+by+generating+a+signed+URL+that+creates+an+embed+user+session+with+a+single+request.\u0026amp;theme=191f8a92cb0a982596561b95\u0026amp;signature=d411f6d006ea2f2f6659497b41ffe91f7bde9879430ad9d47326feeafc6159f2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/omni-e7402367/Hcd24pRrgU0Go9sj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Omni Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5FA2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.omni.co/embed/setup/standard-sso\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/embed/setup/standard-sso.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.omni.co/#organization\",\"name\":\"Omni Docs\",\"url\":\"https://docs.omni.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/omni-e7402367/m1fg0tfdkEcnYhky/images/logo/omni-black.png?fit=max\u0026auto=format\u0026n=m1fg0tfdkEcnYhky\u0026q=85\u0026s=85b81b605382b15b60eb75159899002a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.omni.co#website\",\"name\":\"Omni Docs\",\"url\":\"https://docs.omni.co\",\"publisher\":{\"@id\":\"https://docs.omni.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.omni.co/embed/setup/standard-sso#webpage\",\"url\":\"https://docs.omni.co/embed/setup/standard-sso\",\"name\":\"Embed standard SSO\",\"description\":\"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\",\"dateModified\":\"2026-08-31T22:17:33.175Z\",\"isPartOf\":{\"@id\":\"https://docs.omni.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omni.co/embed/setup/standard-sso#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omni.co/embed/setup/standard-sso#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Setup\",\"item\":\"https://docs.omni.co/embed/setup/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generate user sessions\",\"item\":\"https://docs.omni.co/embed/setup/standard-sso/index\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Standard SSO\",\"item\":\"https://docs.omni.co/embed/setup/standard-sso/index\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Embed standard SSO\",\"item\":\"https://docs.omni.co/embed/setup/standard-sso\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.omni.co/embed/setup/standard-sso#article\",\"headline\":\"Embed standard SSO\",\"name\":\"Embed standard SSO\",\"description\":\"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.\",\"url\":\"https://docs.omni.co/embed/setup/standard-sso\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omni.co/embed/setup/standard-sso#webpage\"},\"dateModified\":\"2026-08-31T22:17:33.175Z\",\"publisher\":{\"@id\":\"https://docs.omni.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.omni.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Omni Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Omni Docs","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/administration"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Library","pages":[{"title":"Library","href":"/library"}]},{"tab":"Developers","menu":[{"item":"REST APIs","icon":"cloud","description":"Programmatically interact with Omni","pages":[{"title":"REST APIs","href":"/api"}]},{"item":"Embedding","icon":"chart-column","description":"Embed Omni's analytics \u0026 AI in apps","pages":[{"group":"Getting started","icon":"hand-sparkles","pages":[{"title":"Embedding Omni in external applications","sidebarTitle":"Overview","href":"/embed"},{"title":"Embedding Omni quickstart","sidebarTitle":"Quickstart","href":"/embed/quickstart"},{"title":"Embedding Omni best practices","sidebarTitle":"Best practices","href":"/embed/best-practices"},{"title":"Embedding limitations","sidebarTitle":"Limitations","href":"/embed/limitations"}]},{"group":"Setup","icon":"flag-checkered","pages":[{"title":"Generating embedded user sessions","sidebarTitle":"Overview","description":"Set up your embedding infrastructure and generate user sessions.","href":"/embed/setup/index"},{"group":"Generate user sessions","pages":[{"group":"Standard SSO","pages":[{"title":"Embed standard SSO","sidebarTitle":"Overview","href":"/embed/setup/standard-sso/index"},{"title":"Setting up embed standard SSO with the v1 signing payload format","sidebarTitle":"v1 format","description":"Set up standard SSO for Omni embedding by generating a signed URL that creates an embed user session with a single request.","href":"/embed/setup/standard-sso/latest"},{"title":"Migrating to the v1 embed standard SSO signing format","sidebarTitle":"Migrate to v1","href":"/embed/setup/standard-sso/migrate-to-latest"},{"title":"Embed standard SSO - Legacy v0 signing format","sidebarTitle":"v0 format","deprecated":true,"href":"/embed/setup/standard-sso/v0-legacy"}]},{"title":"Setting up embed with 2-step SSO","sidebarTitle":"2-step SSO","href":"/embed/setup/two-step-sso"}]},{"group":"Customize users \u0026 sessions","pages":[{"title":"Customizing embed users and sessions with URL parameters","sidebarTitle":"Overview","href":"/embed/setup/customize"},{"title":"Testing embed URL parameters with the URL builder","sidebarTitle":"Test embed URLs","href":"/embed/setup/test-urls"},{"group":"URL parameters","pages":[{"title":"Embed URL parameters reference","sidebarTitle":"All parameters","href":"/embed/setup/url-parameters/index"},{"title":"accessBoost","sidebarTitle":"accessBoost","href":"/embed/setup/url-parameters/accessBoost"},{"title":"branch","sidebarTitle":"branch","href":"/embed/setup/url-parameters/branch"},{"title":"connectionRoles","sidebarTitle":"connectionRoles","href":"/embed/setup/url-parameters/connectionRoles"},{"title":"contentPath","sidebarTitle":"contentPath","href":"/embed/setup/url-parameters/contentPath"},{"title":"customTheme","sidebarTitle":"customTheme","href":"/embed/setup/url-parameters/customTheme"},{"title":"customThemeId","sidebarTitle":"customThemeId","href":"/embed/setup/url-parameters/customThemeId"},{"title":"email","sidebarTitle":"email","href":"/embed/setup/url-parameters/email"},{"title":"entity","sidebarTitle":"entity","href":"/embed/setup/url-parameters/entity"},{"title":"entityAiCreditLimit","sidebarTitle":"entityAiCreditLimit","href":"/embed/setup/url-parameters/entityAiCreditLimit"},{"title":"entityFolderContentRole","sidebarTitle":"entityFolderContentRole","href":"/embed/setup/url-parameters/entityFolderContentRole"},{"title":"entityFolderGroupContentRole","sidebarTitle":"entityFolderGroupContentRole","href":"/embed/setup/url-parameters/entityFolderGroupContentRole"},{"title":"entityFolderLabel","sidebarTitle":"entityFolderLabel","href":"/embed/setup/url-parameters/entityFolderLabel"},{"title":"entityGroupLabel","sidebarTitle":"entityGroupLabel","href":"/embed/setup/url-parameters/entityGroupLabel"},{"title":"externalId","sidebarTitle":"externalId","href":"/embed/setup/url-parameters/externalId"},{"title":"filterSearchParam","sidebarTitle":"filterSearchParam","href":"/embed/setup/url-parameters/filterSearchParam"},{"title":"groups","sidebarTitle":"groups","href":"/embed/setup/url-parameters/groups"},{"title":"linkAccess","sidebarTitle":"linkAccess","href":"/embed/setup/url-parameters/linkAccess"},{"title":"mode","sidebarTitle":"mode","href":"/embed/setup/url-parameters/mode"},{"title":"modelRoles","sidebarTitle":"modelRoles","href":"/embed/setup/url-parameters/modelRoles"},{"title":"name","sidebarTitle":"name","href":"/embed/setup/url-parameters/name"},{"title":"nonce","sidebarTitle":"nonce","href":"/embed/setup/url-parameters/nonce"},{"title":"prefersDark","sidebarTitle":"prefersDark","href":"/embed/setup/url-parameters/prefersDark"},{"title":"preserveEntityFolderContentRole","sidebarTitle":"preserveEntityFolderContentRole","href":"/embed/setup/url-parameters/preserveEntityFolderContentRole"},{"title":"theme","sidebarTitle":"theme","href":"/embed/setup/url-parameters/theme"},{"title":"timezone","sidebarTitle":"timezone","href":"/embed/setup/url-parameters/timezone"},{"title":"uiSettings","sidebarTitle":"uiSettings","href":"/embed/setup/url-parameters/uiSettings"},{"title":"userAttributes","sidebarTitle":"userAttributes","href":"/embed/setup/url-parameters/userAttributes"}]}]}]},{"group":"App customization","icon":"palette","pages":[{"title":"Enabling iframe-restricted functionality for embedded instances","sidebarTitle":"Iframes","href":"/embed/customization/iframes"},{"title":"Setting up custom domains for embed","sidebarTitle":"Custom domains","href":"/embed/customization/vanity-domains"},{"title":"Create Mode for embedded analytics","sidebarTitle":"Create Mode","href":"/embed/customization/create-mode"},{"title":"Applying custom themes and sidebars to embedded Omni","sidebarTitle":"Custom themes \u0026 sidebars","href":"/embed/customization/themes"},{"group":"AI chat","pages":[{"title":"Embedding AI chat","sidebarTitle":"Overview","href":"/embed/customization/ai-chat/index"},{"title":"Embedding the Omni Agent","sidebarTitle":"Omni Agent","href":"/embed/customization/ai-chat/omni-agent"},{"group":"Your own agent","pages":[{"title":"Setting up your own agent for embedded AI chat","sidebarTitle":"Setup","href":"/embed/customization/ai-chat/your-agent-mcp"},{"title":"createEmbedMcpToken reference - Omni Embed","sidebarTitle":"Reference","href":"/embed/customization/ai-chat/mcp-reference"}]}]},{"title":"Configuring email deliveries in embedded Omni","sidebarTitle":"Deliveries","href":"/embed/customization/deliveries"},{"title":"Linking to other content in embedded Omni","sidebarTitle":"Link other content","href":"/embed/customization/link-content"}]},{"group":"Events \u0026 interactivity","icon":"rocket","pages":[{"title":"Embed events","sidebarTitle":"Overview","href":"/embed/events/index"},{"title":"Sending embed events to Omni","sidebarTitle":"Send events to Omni","href":"/embed/events/send"},{"title":"Consuming embed events sent by Omni","sidebarTitle":"Consume Omni events","href":"/embed/events/consume"},{"title":"Sending embed events from Omni visualizations","sidebarTitle":"Emit events from visualizations","href":"/embed/events/visualizations"},{"group":"Supported events","pages":[{"title":"ai:chat-start embed event","sidebarTitle":"ai:chat-start","href":"/embed/events/ai-chat-start"},{"title":"app:event embed event","sidebarTitle":"app:event","href":"/embed/events/app-event"},{"title":"app:filter-changed embed event","sidebarTitle":"app:filter-changed","href":"/embed/events/app-filter-changed"},{"title":"appearance:mode embed event","sidebarTitle":"appearance:mode","href":"/embed/events/appearance-mode"},{"title":"dashboard:download embed event","sidebarTitle":"dashboard:download","href":"/embed/events/dashboard-download"},{"title":"dashboard:filters embed event","sidebarTitle":"dashboard:filters","href":"/embed/events/dashboard-filters"},{"title":"dashboard:filter-changed embed event","sidebarTitle":"dashboard:filter-changed","href":"/embed/events/dashboard-filter-changed"},{"title":"dashboard:filter-change-by-url-parameter embed event","sidebarTitle":"dashboard:filter-change-by-url-parameter","href":"/embed/events/dashboard-filter-change-by-url-parameter"},{"title":"dashboard:ready embed event","sidebarTitle":"dashboard:ready","href":"/embed/events/dashboard-ready"},{"title":"dashboard:set-controls embed event","sidebarTitle":"dashboard:set-controls","href":"/embed/events/dashboard-set-controls"},{"title":"dashboard:set-filters embed event","sidebarTitle":"dashboard:set-filters","href":"/embed/events/dashboard-set-filters"},{"title":"dashboard:tile-download embed event","sidebarTitle":"dashboard:tile-download","href":"/embed/events/dashboard-tile-download"},{"title":"dashboard:tile-drill embed event","sidebarTitle":"dashboard:tile-drill","href":"/embed/events/dashboard-tile-drill"},{"title":"error embed event","sidebarTitle":"error","href":"/embed/events/error"},{"title":"fullscreen:changed embed event","sidebarTitle":"fullscreen:changed","href":"/embed/events/fullscreen-changed"},{"title":"fullscreen:set embed event","sidebarTitle":"fullscreen:set","href":"/embed/events/fullscreen-set"},{"title":"navigate embed event","sidebarTitle":"navigate","href":"/embed/events/navigate"},{"title":"navigation:home embed event","sidebarTitle":"navigation:home","href":"/embed/events/navigation-home"},{"title":"page:changed embed event","sidebarTitle":"page:changed","href":"/embed/events/page-changed"},{"title":"page:ready embed event","sidebarTitle":"page:ready","href":"/embed/events/page-ready"},{"title":"sidebar:open embed event","sidebarTitle":"sidebar:open","href":"/embed/events/sidebar-open"},{"title":"size embed event","sidebarTitle":"size","href":"/embed/events/size"},{"title":"status embed event","sidebarTitle":"status","href":"/embed/events/status"}]}]},{"group":"Admin","icon":"wrench","pages":[{"title":"Embed administration","sidebarTitle":"Overview","href":"/embed/admin/index"},{"title":"Managing embed secrets","sidebarTitle":"Secrets","href":"/embed/admin/secrets"},{"title":"Configuring security and access settings for embedded content","sidebarTitle":"Content security","href":"/embed/admin/security"},{"title":"Managing user sessions","sidebarTitle":"Sessions","href":"/embed/admin/sessions"},{"title":"Managing embed users","sidebarTitle":"Embed users","href":"/embed/admin/users"},{"title":"Managing embed entity groups","sidebarTitle":"Embed entities","href":"/embed/admin/entities"},{"title":"Managing AI credits for embed entity groups","sidebarTitle":"AI credit controls","href":"/embed/admin/ai-credits"},{"title":"Configuring embed integrations","sidebarTitle":"Integrations","href":"/embed/admin/integrations"}]}]},{"item":"CLI","icon":"terminal","description":"Interact with Omni APIs from the terminal","pages":[{"title":"CLI","href":"/developers/cli"}]},{"item":"Agent skills","icon":"robot","description":"Bring Omni workflows into your agent environment","pages":[{"title":"Agent skills","href":"/developers/agent-skills"}]}]},{"tab":"Product updates","menu":[{"item":"Demos","icon":"rocket","description":"Weekly updates of upcoming and experimental features","pages":[{"title":"Demos","href":"/demos"}]},{"item":"Changelog","icon":"file-lines","description":"New features, improvements, and bug fixes","pages":[{"title":"Changelog","href":"/changelog"}]}],"pages":[{"title":"Product updates","href":"/demos"}]}]},"title":"Embed standard SSO - Omni Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["10e4515597"],"chunks":["BannerMarkdown-B-Glu166.js","dist-zbf22OZA.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Cs6nMGht.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}