<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <title>singlestoredb.auth.get_jwt &mdash; SingleStoreDB 1.15.4 documentation</title>
 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
 <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
 <script src="../_static/documentation_options.js?v=8ca4ce02"></script>
 <script src="../_static/doctools.js?v=9a2dae69"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 <script src="../_static/js/theme.js"></script>
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="next" title="singlestoredb.manage_workspaces" href="singlestoredb.manage_workspaces.html" />
 <link rel="prev" title="singlestoredb.connection.Cursor.is_connected" href="singlestoredb.connection.Cursor.is_connected.html" />
</head>
<body class="wy-body-for-nav">
 <div class="wy-grid-for-nav">
 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 <div class="wy-side-scroll">
 <div class="wy-side-nav-search" >
 <a href="../index.html" class="icon icon-home">
 SingleStoreDB
 </a>
 <div class="version">
 1.15.4
 </div>
<div role="search">
 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
</div>
 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
 Contents:
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../whatsnew.html">What’s New</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../api.html#connections">Connections</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html#utilities">Utilities</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">singlestoredb.auth.get_jwt</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#singlestoredb.auth.get_jwt"><code class="docutils literal notranslate">get_jwt()</code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#management-api">Management API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#notebook-tools">Notebook Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#server-tools">Server Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#configuration">Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>
 </div>
 </div>
 </nav>
 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
 
 <a href="../index.html">SingleStoreDB</a>
 </nav>
 <div class="wy-nav-content">
 <div class="rst-content">
 <div role="navigation" aria-label="Page navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
 <li class="breadcrumb-item"><a href="../api.html">API Reference</a></li>
 <li class="breadcrumb-item active">singlestoredb.auth.get_jwt</li>
 <li class="wy-breadcrumbs-aside">
 <a href="../_sources/generated/singlestoredb.auth.get_jwt.rst.txt" rel="nofollow"> View page source</a>
 </li>
 </ul>
 <hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 <section id="singlestoredb-auth-get-jwt">
<h1>singlestoredb.auth.get_jwt<a class="headerlink" href="#singlestoredb-auth-get-jwt" title="Link to this heading">¶</a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="singlestoredb.auth.get_jwt">
singlestoredb.auth.get_jwt(email: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, url: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> = 'https://portal.singlestore.com/engine-sso', clusters: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> | <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>] | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)">None</a> = None, databases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> | <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>] | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)">None</a> = None, timeout: <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a> = 60, browser: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> | <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)">List</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>] | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)">None</a> = None) &#x2192; JSONWebToken<a class="headerlink" href="#singlestoredb.auth.get_jwt" title="Link to this definition">¶</a></dt>
<dd>Retrieve a JWT token from the SingleStoreDB single-sign-on URL.
<dl class="field-list simple">
<dt class="field-odd">Parameters:</dt>
<dd class="field-odd"><ul class="simple">
<li>email (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – EMail of the database user</li>
<li>url (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, optional) – The URL of the single-sign-on token generator</li>
<li>clusters (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>], optional) – The name of the cluster being connected to</li>
<li>databases (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>], optional) – The name of the database being connected to</li>
<li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)">int</a>, optional) – Number of seconds to wait before timing out the authentication request</li>
<li>browser (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>], optional) – Browser to use instead of the default. This value can be any of the
names specified in Python’s <cite>webbrowser</cite> module. This includes
‘google-chrome’, ‘chrome’, ‘chromium’, ‘chromium-browser’, ‘firefox’,
etc. Note that at the time of this writing, Safari was not
compatible. If a list of names is specified, each one tried until
a working browser is located.</li>
</ul>
</dd>
<dt class="field-even">Return type:</dt>
<dd class="field-even">JSONWebToken
</dd>
</dl>
</dd></dl>
</section>
 </div>
 </div>
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 <a href="singlestoredb.connection.Cursor.is_connected.html" class="btn btn-neutral float-left" title="singlestoredb.connection.Cursor.is_connected" accesskey="p" rel="prev"> Previous</a>
 <a href="singlestoredb.manage_workspaces.html" class="btn btn-neutral float-right" title="singlestoredb.manage_workspaces" accesskey="n" rel="next">Next </a>
 </div>
 <hr/>
 <div role="contentinfo">
 &#169; Copyright 2022 SingleStore. All Rights Reserved.
 </div>
 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
 </div>
 </div>
 </section>
 </div>
 <script>
 jQuery(function () {
 SphinxRtdTheme.Navigation.enable(true);
 });
 </script>
</body>
</html>

Collaborative Calculation and Data Science

colby

sagemath

Product

Resources

Company