singlestoredb.auth.get_jwt

singlestoredb.auth.get_jwt(email: str, url: str = 'https://portal.singlestore.com/engine-sso', clusters: str | List[str] | None = None, databases: str | List[str] | None = None, timeout: int = 60, browser: str | List[str] | None = None) → JSONWebToken

Retrieve a JWT token from the SingleStoreDB single-sign-on URL.

Parameters:

  • email (str) – EMail of the database user

  • url (str, optional) – The URL of the single-sign-on token generator

  • clusters (str or list[str], optional) – The name of the cluster being connected to

  • databases (str or list[str], optional) – The name of the database being connected to

  • timeout (int, optional) – Number of seconds to wait before timing out the authentication request

  • browser (str or list[str], optional) – Browser to use instead of the default. This value can be any of the names specified in Python’s webbrowser 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.

Return type:

JSONWebToken