<titledata-rh="true">Interface: AuthenticationGetSessionOptions | Podman Desktop</title><metadata-rh="true"name="viewport"content="width=device-width,initial-scale=1"><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:image"content="https://podman-desktop.io/img/banner_podman-desktop.png"><metadata-rh="true"name="twitter:image"content="https://podman-desktop.io/img/banner_podman-desktop.png"><metadata-rh="true"property="og:url"content="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><metadata-rh="true"property="og:locale"content="en"><metadata-rh="true"name="docusaurus_locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="docusaurus_version"content="current"><metadata-rh="true"name="docusaurus_tag"content="docs-api-current"><metadata-rh="true"name="docsearch:version"content="current"><metadata-rh="true"name="docsearch:docusaurus_tag"content="docs-api-current"><metadata-rh="true"property="og:title"content="Interface: AuthenticationGetSessionOptions | Podman Desktop"><metadata-rh="true"name="description"content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><metadata-rh="true"property="og:description"content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><linkdata-rh="true"rel="icon"href="/img/favicon.ico"><linkdata-rh="true"rel="canonical"href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><linkdata-rh="true"rel="alternate"href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"hreflang="x-default"><linkdata-rh="true"rel="preconnect"href="https://MR01ANKQ9S-dsn.algolia.net"crossorigin="anonymous"><linkrel="alternate"type="application/rss+xml"href="/blog/rss.xml"title="Podman Desktop RSS Feed">
<linkrel="alternate"type="application/atom+xml"href="/blog/atom.xml"title="Podman Desktop Atom Feed">
<script>!function(){functiont(t){document.documentElement.setAttribute("data-theme",t)}vare=function(){try{returnnewURLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{returnlocalStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{constc=newURLSearchParams(window.location.search).entries();for(var[t,e]ofc)if(t.startsWith("docusaurus-data-")){vara=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><divid="__docusaurus"><divrole="region"aria-label="Skip to main content"><aclass="skipToContent_oPtH"href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><navaria-label="Main"class="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Toggle navigation bar"aria-expanded="false"class="navbar__toggle clean-btn"type="button"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><aclass="navbar__brand"href="/"><divclass="navbar__logo"><imgsrc="/img/logo.svg"alt="Podman Desktop Logo"class="themedComponent_siVc themedComponent--light_hHel"height="56"><imgsrc="/img/logo.svg"alt="Podman Desktop Logo"class="themedComponent_siVc themedComponent--dark_yETr"height="56"></div><bclass="navbar__title text--truncate">podman desktop</b></a><aclass="navbar__item navbar__link"href="/docs/intro">Documentation</a><aclass="navbar__item navbar__link"href="/core-values">Core Values</a><aclass="navbar__item navbar__link"href="/features">Features</a><aclass="navbar__item navbar__link"href="/downloads">Downloads</a><aclass="navbar__item navbar__link"href="/extend">Extend</a><aclass="navbar__item navbar__link"href="/blog">Blog</a></div><divclass="navbar__items navbar__items--right"><ahref="https://github.com/containers/podman-desktop"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link header-github-link"></a><divclass="toggle_ki11 colorModeToggle_Hewu"><buttonclass="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m"type="button"disabled=""title="Switch between dark and light mode (currently dark mode)"aria-label="Switch between dark and light mode (currently dark mode)"aria-live="polite"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_lgto"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox="0 0 24 24"width="24"height="24"class="darkToggleIcon_U96C"><pathfill="currentColor"d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51zM12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.9
<p>Options to be used when getting an <ahref="#AuthenticationSession">AuthenticationSession</a> from an <ahref="#AuthenticationProvider">AuthenticationProvider</a>.</p>
<h2class="anchor anchorWithStickyNavbar_JmGV"id="properties">Properties<ahref="#properties"class="hash-link"aria-label="Direct link to Properties"title="Direct link to Properties"></a></h2>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="clearsessionpreference">clearSessionPreference?<ahref="#clearsessionpreference"class="hash-link"aria-label="Direct link to clearSessionPreference?"title="Direct link to clearSessionPreference?"></a></h3>
<p>Whether the existing user session preference should be cleared.</p>
<p>For authentication providers that support being signed into multiple accounts at once, the user will be
prompted to select an account to use when <ahref="#authentication.getSession">getSession</a> is called. This preference
is remembered until <ahref="#authentication.getSession">getSession</a> is called with this flag.</p>
<p>Defaults to false.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source">Source<ahref="#source"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="createifnone">createIfNone?<ahref="#createifnone"class="hash-link"aria-label="Direct link to createIfNone?"title="Direct link to createIfNone?"></a></h3>
<p>Whether login should be performed if there is no matching session.</p>
<p>If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown
on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This
allows quietly prompting the user to sign in.</p>
<p>If there is a matching session but the extension has not been granted access to it, setting this to true
will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.</p>
<p>Defaults to false.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-1">Source<ahref="#source-1"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="forcenewsession">forceNewSession?<ahref="#forcenewsession"class="hash-link"aria-label="Direct link to forceNewSession?"title="Direct link to forceNewSession?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-2">Source<ahref="#source-2"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="silent">silent?<ahref="#silent"class="hash-link"aria-label="Direct link to silent?"title="Direct link to silent?"></a></h3>
<p>Whether we should show the indication to sign in in the Accounts menu.</p>
<p>If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.
If true, no indication will be shown.</p>
<p>Defaults to false.</p>
<p>Note: you cannot use this option with any other options that prompt the user like <ahref="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone</a>.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-3">Source<ahref="#source-3"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
