podman-desktop/api/namespaces/authentication/functions/getSession.html

66 lines
32 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-namespaces/authentication/functions/getSession" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.5.2">
<title data-rh="true">Function: getSession() | 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/namespaces/authentication/functions/getSession"><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="Function: getSession() | Podman Desktop"><meta data-rh="true" name="description" content="getSession(providerId, scopes, options)"><meta data-rh="true" property="og:description" content="getSession(providerId, scopes, options)"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/namespaces/authentication/functions/getSession"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/namespaces/authentication/functions/getSession" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/namespaces/authentication/functions/getSession" 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.01082bb4.css">
<script src="/assets/js/runtime~main.41ce87c7.js" defer="defer"></script>
<script src="/assets/js/main.039a9aa3.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
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="getsessionproviderid-scopes-options">getSession(providerId, scopes, options)<a href="#getsessionproviderid-scopes-options" class="hash-link" aria-label="Direct link to getSession(providerId, scopes, options)" title="Direct link to getSession(providerId, scopes, options)"></a></h2>
<blockquote>
<p><strong>getSession</strong>(<code>providerId</code>, <code>scopes</code>, <code>options</code>): <code>Promise</code>&lt;<a href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
</blockquote>
<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&#x27;s are &#x27;github&#x27; and &#x27;microsoft&#x27;.</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h3>
<p><strong>providerId</strong>: <code>string</code></p>
<p>The id of the provider to use</p>
<p><strong>scopes</strong>: <code>string</code>[]</p>
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
<p><strong>options</strong>: <a href="/api/interfaces/AuthenticationGetSessionOptions"><code>AuthenticationGetSessionOptions</code></a> &amp; <code>object</code></p>
<p>The <a href="#GetSessionOptions">getSessionOptions</a> to use</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h3>
<p><code>Promise</code>&lt;<a href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
<p>A promise that resolves to an authentication session</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in">Defined in<a href="#defined-in" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h3>
<p><a href="https://github.com/containers/podman-desktop/blob/9434f273e5ceb3e3f5278329606773df8d8fa0e7/packages/extension-api/src/extension-api.d.ts#L3915" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3915</a></p>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="getsessionproviderid-scopes-options-1">getSession(providerId, scopes, options)<a href="#getsessionproviderid-scopes-options-1" class="hash-link" aria-label="Direct link to getSession(providerId, scopes, options)" title="Direct link to getSession(providerId, scopes, options)"></a></h2>
<blockquote>
<p><strong>getSession</strong>(<code>providerId</code>, <code>scopes</code>, <code>options</code>?): <code>Promise</code>&lt;<a href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
</blockquote>
<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&#x27;s are &#x27;github&#x27; and &#x27;microsoft&#x27;.</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="parameters-1">Parameters<a href="#parameters-1" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h3>
<p><strong>providerId</strong>: <code>string</code></p>
<p>The id of the provider to use</p>
<p><strong>scopes</strong>: <code>string</code>[]</p>
<p>A list of scopes representing the permissions requested. These are dependent on the authentication provider</p>
<p><strong>options?</strong>: <a href="/api/interfaces/AuthenticationGetSessionOptions"><code>AuthenticationGetSessionOptions</code></a></p>
<p>The <a href="#GetSessionOptions">getSessionOptions</a> to use</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="returns-1">Returns<a href="#returns-1" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h3>
<p><code>Promise</code>&lt;<a href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
<p>A promise that resolves to an authentication session if available, or undefined if there are no sessions</p>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-1">Defined in<a href="#defined-in-1" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h3>
<p><a href="https://github.com/containers/podman-desktop/blob/9434f273e5ceb3e3f5278329606773df8d8fa0e7/packages/extension-api/src/extension-api.d.ts#L3934" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:3934</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/namespaces/authentication"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">authentication</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/namespaces/authentication/functions/onDidChangeSessions"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">onDidChangeSessions</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 href="#getsessionproviderid-scopes-options" class="table-of-contents__link toc-highlight">getSession(providerId, scopes, options)</a><ul><li><a href="#parameters" class="table-of-contents__link toc-highlight">Parameters</a></li><li><a href="#returns" class="table-of-contents__link toc-highlight">Returns</a></li><li><a href="#defined-in" class="table-of-contents__link toc-highlight">Defined in</a></li></ul></li><li><a href="#getsessionproviderid-scopes-options-1" class="table-of-contents__link toc-highlight">getSession(providerId, scopes, options)</a><ul><li><a href="#parameters-1" class="table-of-contents__link toc-highlight">Parameters</a></li><li><a href="#returns-1" class="table-of-contents__link toc-highlight">Returns</a></li><li><a href="#defined-in-1" class="table-of-contents__link toc-highlight">Defined in</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="foote
</body>
</html>