<script>!function(){functiont(t){document.documentElement.setAttribute("data-theme",t)}vare=function(){try{returnnewURLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{returnwindow.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{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="/downloads">Downloads</a><aclass="navbar__item navbar__link"href="/community">Community</a><divclass="navbar__item dropdown dropdown--hoverable"><ahref="#"aria-haspopup="true"aria-expanded="false"role="button"class="navbar__link">Resources</a><ulclass="dropdown__menu"><li><aclass="dropdown__link"href="/features">Features</a></li><li><aclass="dropdown__link"href="/tutorial">Tutorials</a></li><li><aclass="dropdown__link"href="/extend">Extend</a></li></ul></div><aclass="navbar__item navbar__link"href="/blog">Blog</a></div><divclass="navbar__items navbar__items--right"><ahref="https://github.com/podman-desktop/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"aria-pressed="true"><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
<h2class="anchor anchorWithStickyNavbar_JmGV"id="call-signature">Call Signature<ahref="#call-signature"class="hash-link"aria-label="Direct link to Call Signature"title="Direct link to Call Signature"></a></h2>
<p>Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
registered, or if the user does not consent to sharing authentication information with
the extension. If there are multiple sessions with the same scopes, the user will be shown a
quickpick to select which account they would like to use.</p>
<p>Currently, there are only two authentication providers that are contributed from built in extensions
to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.</p>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="parameters">Parameters<ahref="#parameters"class="hash-link"aria-label="Direct link to Parameters"title="Direct link to Parameters"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="providerid">providerId<ahref="#providerid"class="hash-link"aria-label="Direct link to providerId"title="Direct link to providerId"></a></h4>
<p><code>string</code></p>
<p>The id of the provider to use</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="scopes">scopes<ahref="#scopes"class="hash-link"aria-label="Direct link to scopes"title="Direct link to scopes"></a></h4>
<p><code>string</code>[]</p>
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="options">options<ahref="#options"class="hash-link"aria-label="Direct link to options"title="Direct link to options"></a></h4>
<p>The <ahref="#GetSessionOptions">getSessionOptions</a> to use</p>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="returns">Returns<ahref="#returns"class="hash-link"aria-label="Direct link to Returns"title="Direct link to Returns"></a></h3>
<p>A promise that resolves to an authentication session</p>
<h2class="anchor anchorWithStickyNavbar_JmGV"id="call-signature-1">Call Signature<ahref="#call-signature-1"class="hash-link"aria-label="Direct link to Call Signature"title="Direct link to Call Signature"></a></h2>
<p>Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
registered, or if the user does not consent to sharing authentication information with
the extension. If there are multiple sessions with the same scopes, the user will be shown a
quickpick to select which account they would like to use.</p>
<p>Currently, there are only two authentication providers that are contributed from built in extensions
to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.</p>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="parameters-1">Parameters<ahref="#parameters-1"class="hash-link"aria-label="Direct link to Parameters"title="Direct link to Parameters"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="providerid-1">providerId<ahref="#providerid-1"class="hash-link"aria-label="Direct link to providerId"title="Direct link to providerId"></a></h4>
<p><code>string</code></p>
<p>The id of the provider to use</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="scopes-1">scopes<ahref="#scopes-1"class="hash-link"aria-label="Direct link to scopes"title="Direct link to scopes"></a></h4>
<p><code>string</code>[]</p>
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="options-1">options?<ahref="#options-1"class="hash-link"aria-label="Direct link to options?"title="Direct link to options?"></a></h4>
<p>The <ahref="#GetSessionOptions">getSessionOptions</a> to use</p>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="returns-1">Returns<ahref="#returns-1"class="hash-link"aria-label="Direct link to Returns"title="Direct link to Returns"></a></h3>
<divclass="text-xs">The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <ahref="https://www.linuxfoundation.org/trademark-usage/"> Trademark Usage</a> page.
