Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

7.2 KB
Raw Blame
---
title: MetabaseIsGuestAuthConfig
layout: docs-api
redirect_from:
  - /docs/latest/embedding/api/MetabaseIsGuestAuthConfig
---

<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MetabaseIsGuestAuthConfig | Embedded analytics SDK API</title><link rel="icon" href="assets/favicon.ico"/>{% include docs/embedded-analytics-sdk-metadata.html %}<meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script defer src="assets/custom.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Embedded analytics SDK API</a><div id="tsd-toolbar-links"><a href="javascript:navigateBack({ fallbackUrl: '/docs/latest/embedding/sdk/introduction' })">Back to documentation</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">MetabaseIsGuestAuthConfig</a></li></ul><h1>Type Alias MetabaseIsGuestAuthConfig</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">MetabaseIsGuestAuthConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">metabaseInstanceUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">apiKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">fetchRequestToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">guestEmbedProviderUri</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">isGuest</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">preferredAuthMethod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">metabaseInstanceUrl</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">apiKey</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">never</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">fetchRequestToken</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">never</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">guestEmbedProviderUri</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>URL endpoint for fetching and refreshing guest embed JWT tokens (iframe only, not applicable for SDK's guest mode).
Supports both token refresh on expiry and initial token fetch when no static token is provided.
In both cases, this works with guest embed components (metabase-dashboard and metabase-question).
The endpoint should return { jwt: string } with the new token.</p>
</div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">isGuest</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span></h5><div class="tsd-comment tsd-typography"><p>Defines if SDK should work in a Guest Embed mode</p>
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">preferredAuthMethod</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">never</span></h5></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="javascript:navigateBack({ fallbackUrl: '/docs/latest/embedding/sdk/introduction' })" class="tsd-nav-link">Back to documentation</a></nav><nav class="tsd-navigation"><a href="index.html">Embedded analytics SDK API</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p><script type="text/javascript" src="/gdpr-cookie-notice/dist/script.js"></script><script type="text/javascript" src="/js/cookie-consent.js"></script><link href="/gdpr-cookie-notice/dist/style.css" rel="stylesheet" /><link href="/css/gdpr.css" rel="stylesheet" /></p></footer><div class="overlay"></div></body></html>