podman-desktop/api/interfaces/AuthenticationGetSessionOptions.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/AuthenticationGetSessionOptions" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">Interface: AuthenticationGetSessionOptions | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: AuthenticationGetSessionOptions | Podman Desktop"><meta data-rh="true" name="description" content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><meta data-rh="true" property="og:description" content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">


<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">

<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.5145b54b.css">
<script src="/assets/js/runtime~main.75fde523.js" defer="defer"></script>
<script src="/assets/js/main.173d10ec.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.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{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="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"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="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><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="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,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,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.36 c-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
<p>Options to be used when getting an <a href="/api/interfaces/AuthenticationGetSessionOptions#AuthenticationSession">AuthenticationSession</a> from an <a href="/api/interfaces/AuthenticationGetSessionOptions#AuthenticationProvider">AuthenticationProvider</a>.</p>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/interfaces/AuthenticationGetSessionOptions#properties"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="clearsessionpreference">clearSessionPreference?<a class="hash-link" aria-label="Direct link to clearSessionPreference?" title="Direct link to clearSessionPreference?" href="/api/interfaces/AuthenticationGetSessionOptions#clearsessionpreference"></a></h3>
<blockquote>
<p><code>optional</code> <strong>clearSessionPreference</strong>: <code>boolean</code></p>
</blockquote>
<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 <a href="/api/interfaces/AuthenticationGetSessionOptions#authentication.getSession">getSession</a> is called. This preference
is remembered until <a href="/api/interfaces/AuthenticationGetSessionOptions#authentication.getSession">getSession</a> is called with this flag.</p>
<p>Defaults to false.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3501" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3501</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="createifnone">createIfNone?<a class="hash-link" aria-label="Direct link to createIfNone?" title="Direct link to createIfNone?" href="/api/interfaces/AuthenticationGetSessionOptions#createifnone"></a></h3>
<blockquote>
<p><code>optional</code> <strong>createIfNone</strong>: <code>boolean</code></p>
</blockquote>
<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>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-1">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-1"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3490" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3490</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="forcenewsession">forceNewSession?<a class="hash-link" aria-label="Direct link to forceNewSession?" title="Direct link to forceNewSession?" href="/api/interfaces/AuthenticationGetSessionOptions#forcenewsession"></a></h3>
<blockquote>
<p><code>optional</code> <strong>forceNewSession</strong>: <code>boolean</code> | <code>object</code></p>
</blockquote>
<p>Whether we should attempt to reauthenticate even if there is already a session available.</p>
<p>If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
where the token needs to be re minted because it has lost some authorization.</p>
<p>If there are no existing sessions and forceNewSession is true, it will behave identically to
<a href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone</a>.</p>
<p>This defaults to false.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-2">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-2"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3514" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3514</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="silent">silent?<a class="hash-link" aria-label="Direct link to silent?" title="Direct link to silent?" href="/api/interfaces/AuthenticationGetSessionOptions#silent"></a></h3>
<blockquote>
<p><code>optional</code> <strong>silent</strong>: <code>boolean</code></p>
</blockquote>
<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 <a href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone</a>.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-3">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-3"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3526" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3526</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/AuthConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">AuthConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/AuthenticationProvider"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">AuthenticationProvider</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#properties">Properties</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#clearsessionpreference">clearSessionPreference?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#forcenewsession">forceNewSession?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#silent">silent?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/containers/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/containers/projects/4/views/8" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="cur
</body>
</html>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<!doctype html>
 								<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/AuthenticationGetSessionOptions" data-has-hydrated="false">
 								<head>
 								<meta charset="UTF-8">
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<meta name="generator" content="Docusaurus v3.4.0">
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<title data-rh="true">Interface: AuthenticationGetSessionOptions | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: AuthenticationGetSessionOptions | Podman Desktop"><meta data-rh="true" name="description" content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><meta data-rh="true" property="og:description" content="Options to be used when getting an AuthenticationSession from an AuthenticationProvider."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/AuthenticationGetSessionOptions" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
 								<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
 								<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">
 								<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">
 								<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
-												deploy: 78ab605052827e19535a3a1b5167b3b2f1f49bcd

											
										
										
											2024-05-28 23:34:19 +00:00
+								<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.5145b54b.css">
-												deploy: 35878935fcaac0355f94b7747fa736551d2db0a6

											
										
										
											2024-06-05 11:46:44 +00:00
+								<script src="/assets/js/runtime~main.75fde523.js" defer="defer"></script>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<script src="/assets/js/main.173d10ec.js" defer="defer"></script>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</head>
 								<body class="navigation-with-keyboard">
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.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{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="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"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="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><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="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,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,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.36 c-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
 								<p>Options to be used when getting an <a href="/api/interfaces/AuthenticationGetSessionOptions#AuthenticationSession">AuthenticationSession</a> from an <a href="/api/interfaces/AuthenticationGetSessionOptions#AuthenticationProvider">AuthenticationProvider</a>.</p>
 								<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/interfaces/AuthenticationGetSessionOptions#properties"></a></h2>
 								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="clearsessionpreference">clearSessionPreference?<a class="hash-link" aria-label="Direct link to clearSessionPreference?" title="Direct link to clearSessionPreference?" href="/api/interfaces/AuthenticationGetSessionOptions#clearsessionpreference"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>clearSessionPreference</strong>: <code>boolean</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<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
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								prompted to select an account to use when <a href="/api/interfaces/AuthenticationGetSessionOptions#authentication.getSession">getSession</a> is called. This preference
 								is remembered until <a href="/api/interfaces/AuthenticationGetSessionOptions#authentication.getSession">getSession</a> is called with this flag.</p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<p>Defaults to false.</p>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source"></a></h4>
-												deploy: 35878935fcaac0355f94b7747fa736551d2db0a6

											
										
										
											2024-06-05 11:46:44 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3501" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3501</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="createifnone">createIfNone?<a class="hash-link" aria-label="Direct link to createIfNone?" title="Direct link to createIfNone?" href="/api/interfaces/AuthenticationGetSessionOptions#createifnone"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>createIfNone</strong>: <code>boolean</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<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>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-1">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-1"></a></h4>
-												deploy: 35878935fcaac0355f94b7747fa736551d2db0a6

											
										
										
											2024-06-05 11:46:44 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3490" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3490</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="forcenewsession">forceNewSession?<a class="hash-link" aria-label="Direct link to forceNewSession?" title="Direct link to forceNewSession?" href="/api/interfaces/AuthenticationGetSessionOptions#forcenewsession"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>forceNewSession</strong>: <code>boolean</code> | <code>object</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<p>Whether we should attempt to reauthenticate even if there is already a session available.</p>
 								<p>If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
 								where the token needs to be re minted because it has lost some authorization.</p>
 								<p>If there are no existing sessions and forceNewSession is true, it will behave identically to
 								<a href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone</a>.</p>
 								<p>This defaults to false.</p>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-2">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-2"></a></h4>
-												deploy: 35878935fcaac0355f94b7747fa736551d2db0a6

											
										
										
											2024-06-05 11:46:44 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3514" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3514</a></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<hr>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h3 class="anchor anchorWithStickyNavbar_JmGV" id="silent">silent?<a class="hash-link" aria-label="Direct link to silent?" title="Direct link to silent?" href="/api/interfaces/AuthenticationGetSessionOptions#silent"></a></h3>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								<blockquote>
-												deploy: 913e923c9731ff8cb55c8e36ffdd866e25b6442a

											
										
										
											2024-04-23 13:30:46 +00:00
+								<p><code>optional</code> <strong>silent</strong>: <code>boolean</code></p>
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</blockquote>
 								<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 <a href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone</a>.</p>
-												deploy: 6b93dc5d129d3e3fd8c5f303d5f460805c4b6b65

											
										
										
											2024-06-05 08:03:38 +00:00
+								<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-3">Source<a class="hash-link" aria-label="Direct link to Source" title="Direct link to Source" href="/api/interfaces/AuthenticationGetSessionOptions#source-3"></a></h4>
-												deploy: 35878935fcaac0355f94b7747fa736551d2db0a6

											
										
										
											2024-06-05 11:46:44 +00:00
+								<p><a href="https://github.com/containers/podman-desktop/blob/35878935fcaac0355f94b7747fa736551d2db0a6/packages/extension-api/src/extension-api.d.ts#L3526" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3526</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/AuthConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">AuthConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/AuthenticationProvider"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">AuthenticationProvider</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#properties">Properties</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#clearsessionpreference">clearSessionPreference?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#createifnone">createIfNone?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#forcenewsession">forceNewSession?</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/AuthenticationGetSessionOptions#silent">silent?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/containers/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/containers/projects/4/views/8" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="cur
-												deploy: f8a3f5c04def1fceac66c2663588b7c37522934f

											
										
										
											2024-03-04 10:44:38 +00:00
+								</body>
 								</html>