iqm-client 31.8.0__tar.gz → 32.0.0__tar.gz

{iqm_client-31.8.0 → iqm_client-32.0.0}/CHANGELOG.rst

@@ -2,6 +2,15 @@
 Changelog
 =========
 
+Version 32.0.0 (2025-10-09)
+===========================
+
+Breaking changes
+----------------
+
+- Remove the Cortex CLI authentication utility. See the updated user guides.
+- Remove :mod:`iqm.qiskit_iqm.examples.resonance_example`.
+
 Version 31.8.0 (2025-10-06)
 ===========================
 

{iqm_client-31.8.0 → iqm_client-32.0.0}/INTEGRATION_GUIDE.rst

@@ -100,22 +100,9 @@ Authentication
 --------------
 
 IQM uses bearer token authentication to manage access to quantum computers.
-Currently, there are three mutually exclusive ways of providing an authentication
-token to IQM client:
-
-1. The recommended way is to use :ref:`IQM Client CLI <User guide CLI>`
-   to manage the authentication tokens and store them into a file. IQM client can then read
-   the token from the file and use it for authentication. The file path can be provided to
-   IQM client in environment variable :envvar:`IQM_TOKENS_FILE`.
-   Alternatively, the tokens file path can be provided as argument ``tokens_file`` to
-   :class:`.IQMClient` constructor.
-
-2. It is also possible to use plaintext token obtained from a server dashboard. These
-   tokens may have longer lifespan than access tokens generated by IQM Client CLI, and thus
-   IQM client won't attempt to refresh them. The generated token can be provided to IQM
-   client in environment variable :envvar:`IQM_TOKEN`.
-   Alternatively, the token can be provided as argument ``token`` to :class:`.IQMClient`
-   constructor.
+Get your personal token from the web dashboard. The generated token can be provided to IQM
+client via an environment variable :envvar:`IQM_TOKEN`.
+Alternatively, the token can be provided as argument ``token`` to :class:`.IQMClient` constructor.
 
 Circuit transpilation
 ---------------------

{iqm_client-31.8.0 → iqm_client-32.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 31.8.0
+Version: 32.0.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License

{iqm_client-31.8.0 → iqm_client-32.0.0}/docs/index.rst

@@ -10,8 +10,6 @@ Includes `Qiskit <https://qiskit.org/>`_ and `Cirq <https://quantumai.google/cir
 `IQM's <https://www.meetiqm.com>`_ quantum computers. See user guides for :ref:`Qiskit <User guide Qiskit>` and
 :ref:`Cirq <User guide Cirq>` for introductions on how to install and use the adapters.
 
-Also includes a :ref:`CLI utility <User guide CLI>` for managing user authentication when using IQM quantum computers.
-
 Contents
 ========
 
@@ -21,7 +19,6 @@ Contents
    readme
    API
    integration_guide
-   user_guide_cli
    user_guide_qiskit
    user_guide_cirq
    license

{iqm_client-31.8.0 → iqm_client-32.0.0}/docs/user_guide_cirq.rst

@@ -435,23 +435,12 @@ as explained in the :ref:`routing` section above.
 Authentication
 ^^^^^^^^^^^^^^
 
-IQM Resonance
-"""""""""""""
+There are two options to authenticate:
 
-If you are using IQM Resonance, you have two options to authenticate:
-
-1. Set the :envvar:`IQM_TOKEN` environment variable with the API token obtained from the Resonance dashboard.
+1. Set the :envvar:`IQM_TOKEN` environment variable with the API token obtained from the web dashboard.
 2. Pass the ``token`` parameter to :class:`.IQMSampler`. This will be forwarded to
    :class:`~iqm.iqm_client.iqm_client.IQMClient`.
 
-On-premises devices
-"""""""""""""""""""
-
-If the IQM server you are connecting to requires authentication, you may use
-:ref:`IQM Client CLI <User guide CLI>` to retrieve and automatically refresh access tokens,
-then set the :envvar:`IQM_TOKENS_FILE` environment variable, as instructed, to point to the tokens file.
-See IQM Client CLI's `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`__ for details.
-
 Batch execution
 ^^^^^^^^^^^^^^^
 

{iqm_client-31.8.0 → iqm_client-32.0.0}/docs/user_guide_qiskit.rst

@@ -16,26 +16,22 @@ Hello, world!
 -------------
 
 Here's a quick and easy way to run a small computation on an IQM quantum computer to check that
-things are set up correctly, either
-through the IQM cloud service Resonance, or using an on-premises quantum computer.
+things are set up correctly.
 
-IQM Resonance
-~~~~~~~~~~~~~
-
-1. Login to `IQM Resonance <https://resonance.meetiqm.com>`_ with your credentials.
-2. Upon your first visit to IQM Resonance, you can generate your unique, non-recoverable API token
+1. Login to the web dashboard with your credentials. If you're using the IQM Resonance cloud service, go to
+   `IQM Resonance <https://resonance.meetiqm.com>`_.
+2. Upon your first visit, you can generate your unique, non-recoverable API token
    directly from the Dashboard page by selecting ``Generate token``. It's important to copy the token
    immediately from the window, as you won't be able to do so once the window is closed. If you lose
    your token, you have the option to regenerate it at any time. However, be aware that regenerating
    your API token will invalidate any previously generated token.
-3. Download one of the demo notebooks from `IQM Academy <https://www.iqmacademy.com/tutorials/>`_ or the
-   `resonance_example.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
+3. Store your API token in the environment variable :envvar:`IQM_TOKEN`.
+4. Download one of the demo notebooks from `IQM Academy <https://www.iqmacademy.com/tutorials/>`_ or the
+   `bell_measure.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.py>`_
    (Save Page As...)
-4. Install Qiskit on IQM as instructed below.
-5. Add your API token to the example (either as the parameter ``token`` to the :class:`.IQMProvider`
-   constructor, or by setting the environment variable :envvar:`IQM_TOKEN`)
+5. Install Qiskit on IQM as instructed below.
 6. Run the Jupyter notebook (or run
-   ``python resonance_example.py --url https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>``
+   ``python bell_measure.py --url https://<IQM server URL>``
    if you decided to go for the Python script).
 7. If you're connecting to a real quantum computer, the output should show almost half of the
    measurements resulting in '00000' and almost half in '11111' - if this is the case, things are
@@ -45,20 +41,6 @@ You can find a video guide on how to set things up `here <https://www.iqmacademy
 More ready-to-run examples can also be found at `IQM Academy <https://www.iqmacademy.com/tutorials/>`_.
 
 
-On-premises device
-~~~~~~~~~~~~~~~~~~
-
-1. Download the `bell_measure.py example file <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.py>`_ (Save Page As...).
-2. Install Qiskit on IQM as instructed below.
-3. Install IQM Client CLI and log in as instructed in the
-   `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html#installing-iqm-client-cli>`__
-4. Set the environment variable as instructed by IQM Client CLI after logging in.
-5. Run ``$ python bell_measure.py --url https://<YOUR IQM SERVER>`` - replace the example URL with the correct one.
-6. If you're connecting to a real quantum computer, the output should show almost half of the
-   measurements resulting in '00' and almost half in '11' - if this is the case, things are set up
-   correctly!
-
-
 Installation
 ------------
 
@@ -86,25 +68,13 @@ After installation, Qiskit on IQM can be imported in your Python code as follows
 Authentication
 --------------
 
-IQM Resonance
-~~~~~~~~~~~~~
+There are two options to authenticate:
 
-If you are using IQM Resonance, you have two options to authenticate:
-
-1. Set the :envvar:`IQM_TOKEN` environment variable to the API token obtained from the Resonance dashboard.
+1. Set the :envvar:`IQM_TOKEN` environment variable to the API token obtained from the web dashboard.
 2. Pass the ``token`` parameter to :class:`.IQMProvider`. This will be forwarded to
-   :class:`~iqm.iqm_client.iqm_client.IQMClient`. For an example, see the `resonance_example.py file
-   <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/resonance_example.py>`_
-
-On-premises devices
-~~~~~~~~~~~~~~~~~~~
-
-If the IQM server you are connecting to requires authentication, you may use
-:ref:`IQM Client CLI <User guide CLI>` to retrieve and automatically refresh access tokens,
-then set the :envvar:`IQM_TOKENS_FILE` environment variable, as instructed, to point to the tokens file.
-See IQM Client CLI's `documentation <https://docs.meetiqm.com/iqm-client/user_guide_cli.html>`__ for details.
+   :class:`~iqm.iqm_client.iqm_client.IQMClient`. For an example, see
+   `bell_measure.py <https://raw.githubusercontent.com/iqm-finland/sdk/refs/heads/main/iqm_client/src/iqm/qiskit_iqm/examples/bell_measure.py>`_
 
-You may also authenticate yourself by setting the access token in the the :envvar:`IQM_TOKEN` variable
 
 Running quantum circuits on an IQM quantum computer
 ---------------------------------------------------
@@ -180,10 +150,9 @@ circuit(s) are sampled:
 
     As of ``iqm-client >= 30.1.0``, structured quality metrics and calibration data are available to
     ``IQMTarget`` for improved transpilation. To import the latest valid quality metric data corresponding
-    to the default calibration set into ``IQMTarget``, set ``use_metrics`` to ``True`` when initializing the 
+    to the default calibration set into ``IQMTarget``, set ``use_metrics`` to ``True`` when initializing the
     class. For Resonance users, this data is not yet available via the Resonance API, so use the default setting
     of ``use_metrics`` of ``False``.
-    
 
 You can optionally provide IQMBackend specific options as additional keyword arguments to
 :meth:`.IQMBackend.run`, documented at :meth:`.IQMBackend.create_run_request`.

{iqm_client-31.8.0 → iqm_client-32.0.0}/src/iqm/iqm_client/authentication.py

@@ -22,9 +22,6 @@ from typing import Any
 
 from iqm.iqm_client.errors import ClientAuthenticationError, ClientConfigurationError
 
-AUTH_CLIENT_ID = "iqm_client"
-AUTH_REALM = "cortex"
-AUTH_REQUESTS_TIMEOUT = float(os.environ.get("IQM_CLIENT_REQUESTS_TIMEOUT", 60.0))
 REFRESH_MARGIN_SECONDS = 60
 
 

iqm_client-31.8.0/src/iqm/qiskit_iqm/examples/resonance_example.py → iqm_client-32.0.0/src/iqm/qiskit_iqm/examples/bell_measure.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Qiskit on IQM developers
+# Copyright 2023 Qiskit on IQM developers
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,44 +11,45 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""This file is an example of using Qiskit on IQM to run a simple but non-trivial quantum circuit on
-Resonance, the IQM quantum cloud service.
+"""An example on using Qiskit on IQM to run a simple quantum circuit on an IQM quantum computer.
+
 See the Qiskit on IQM user guide for instructions:
 https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html
 """
 
 import argparse
 
-from iqm.qiskit_iqm import IQMProvider
+from iqm.qiskit_iqm.iqm_provider import IQMProvider
 from qiskit import QuantumCircuit, transpile
 
 
-def resonance_example(server_url: str, api_token: str | None) -> dict[str, int]:
-    """Run a circuit via IQM Resonance.
+def bell_measure(server_url: str, token: str | None = None, shots: int = 1000) -> dict[str, int]:
+    """Execute a quantum circuit that prepares and measures a generalized Bell (aka GHZ) state.
 
     Args:
-        server_url: URL of the IQM Resonance QC used for execution
-        api_token: IQM Resonance API token for authentication
+        server_url: URL of the IQM server used for execution
+        token: API token for authentication. If not given, uses :env:`IQM_TOKEN`.
+        shots: Requested number of shots.
 
     Returns:
-        a mapping of bitstrings representing qubit measurement results to counts for each result
+        Mapping of bitstrings representing qubit measurement results to counts for each result.
 
     """
-    SHOTS = 1000
-
+    print(f"Executing a circuit on {server_url}")
     # Initialize a backend without metrics as IQMClient._get_calibration_quality_metrics is not supported by resonance
-    backend = IQMProvider(server_url, token=api_token).get_backend()
+    backend = IQMProvider(server_url, token=token).get_backend()
+    if backend.num_qubits < 2:
+        raise ValueError("We need two qubits for the Bell state.")
 
     # Just to make sure that "get_static_quantum_architecture" method works
     static_quantum_architecture = backend.client.get_static_quantum_architecture()
     print(f"static_quantum_architecture={static_quantum_architecture}")
 
-    # Define a quantum circuit
-    num_qb = min(backend.num_qubits, 5)  # use at most 5 qubits
-    qc = QuantumCircuit(num_qb)
-
+    # Define a quantum circuit for a GHZ state
+    n_qubits = min(backend.num_qubits, 5)  # use at most 5 qubits
+    qc = QuantumCircuit(n_qubits)
     qc.h(0)
-    for qb in range(1, num_qb):
+    for qb in range(1, n_qubits):
         qc.cx(0, qb)
     qc.barrier()
     qc.measure_all()
@@ -58,26 +59,22 @@ def resonance_example(server_url: str, api_token: str | None) -> dict[str, int]:
     print(qc_transpiled.draw(output="text"))
 
     # Run the circuit
-    job = backend.run(qc_transpiled, shots=SHOTS)
+    job = backend.run(qc_transpiled, shots=shots)
     return job.result().get_counts()
 
 
 if __name__ == "__main__":
     argparser = argparse.ArgumentParser()
     argparser.add_argument(
-        "--url",
-        help="URL of the IQM Resonance QC",
-        # For example https://cocos.resonance.meetiqm.com/garnet
-        default="https://cocos.resonance.meetiqm.com/<RESONANCE QC NAME>",
+        "--url", required=True, help='IQM server URL, for example "https://cocos.resonance.meetiqm.com/garnet"'
     )
     argparser.add_argument(
         "--token",
-        help="IQM Resonance access token",
+        help="API token for authentication",
         # Provide the API token explicitly or set it as an environment variable
         # following the https://docs.meetiqm.com/iqm-client/user_guide_qiskit.html#authentication
-        default="<INSERT YOUR TOKEN>",
     )
 
     args = argparser.parse_args()
-    results = resonance_example(args.url, args.token)
-    print(results)
+    counts = bell_measure(args.url, args.token)
+    print(counts)

{iqm_client-31.8.0 → iqm_client-32.0.0}/src/iqm_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-client
-Version: 31.8.0
+Version: 32.0.0
 Summary: Client library for accessing an IQM quantum computer
 Author-email: IQM Finland Oy <developers@meetiqm.com>
 License:                                  Apache License

{iqm_client-31.8.0 → iqm_client-32.0.0}/src/iqm_client.egg-info/SOURCES.txt

@@ -22,7 +22,6 @@ docs/integration_guide.rst
 docs/license.rst
 docs/readme.rst
 docs/user_guide_cirq.rst
-docs/user_guide_cli.rst
 docs/user_guide_qiskit.rst
 docs/_static/images/favicon.ico
 docs/_static/images/logo.png
@@ -66,11 +65,6 @@ src/iqm/iqm_client/py.typed
 src/iqm/iqm_client/transpile.py
 src/iqm/iqm_client/util.py
 src/iqm/iqm_client/validation.py
-src/iqm/iqm_client/cli/__init__.py
-src/iqm/iqm_client/cli/auth.py
-src/iqm/iqm_client/cli/cli.py
-src/iqm/iqm_client/cli/models.py
-src/iqm/iqm_client/cli/token_manager.py
 src/iqm/qiskit_iqm/__init__.py
 src/iqm/qiskit_iqm/iqm_backend.py
 src/iqm/qiskit_iqm/iqm_circuit.py
@@ -87,7 +81,6 @@ src/iqm/qiskit_iqm/qiskit_to_iqm.py
 src/iqm/qiskit_iqm/transpiler_plugins.py
 src/iqm/qiskit_iqm/examples/__init__.py
 src/iqm/qiskit_iqm/examples/bell_measure.py
-src/iqm/qiskit_iqm/examples/resonance_example.py
 src/iqm/qiskit_iqm/examples/transpile_example.py
 src/iqm/qiskit_iqm/fake_backends/__init__.py
 src/iqm/qiskit_iqm/fake_backends/fake_adonis.py

iqm_client-32.0.0/version.txt

@@ -0,0 +1 @@
+32.0.0

iqm_client-31.8.0/docs/user_guide_cli.rst

@@ -1,137 +0,0 @@
-.. _User guide CLI:
-
-=========================
-IQM Client CLI User Guide
-=========================
-
-Command-line interface (CLI) for managing user authentication when using IQM quantum computers.
-
-Installing IQM Client CLI
--------------------------
-
-.. code-block:: bash
-
-  $ pip install iqm-client[cli]
-
-Using IQM Client CLI
---------------------
-
-For general usage instructions, run
-
-.. code-block:: bash
-
-  $ iqmclient --help
-
-Initialization
-^^^^^^^^^^^^^^
-
-First, IQM Client CLI needs initialization, which produces a configuration file:
-
-.. code-block:: bash
-
-  $ iqmclient init
-
-IQM Client CLI will ask a few questions. You can also pass the values via command line to avoid having an interactive
-prompt. See ``iqmclient init --help`` for details.
-
-Login
-^^^^^
-
-To log in, use
-
-.. code-block:: bash
-
-  $ iqmclient auth login
-
-This will ask you to enter your username and password. If you have a temporary password you will be asked to go to the
-authentication server and enter a new password. URL of the authentication server will be provided.
-
-After a successful authentication, tokens will be saved into a tokens file (path specified in the configuration file),
-and a token manager daemon will start in the background. Token manager will periodically refresh the session and
-re-write the tokens file.
-
-To use the token manager in a foreground mode (not as daemon), run ``iqmclient auth login --no-daemon``. This requires
-keeping the shell session alive. However, you can start the process in the background by adding ``&`` after the
-command: ``iqmclient auth login --no-daemon &``. This applies to Bash, zsh and similar shells, but may not be available
-on all shells.
-
-To login and get tokens once, without starting a token manager at all, run ``iqmclient auth login --no-refresh``.
-
-If the tokens file already exists, then running ``iqmclient auth login`` will first attempt to refresh the session
-without asking you for a username and password. If that fails (because existing tokens may already have expired), you'll
-be asked to re-enter your credentials.
-
-See ``iqmclient auth login --help`` for more details.
-
-Use with Cirq on IQM, Qiskit on IQM, etc.
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Adapters based on IQM Client, such as Cirq on IQM and Qiskit on IQM, can take advantage of the tokens file maintained by
-IQM Client CLI. This way you won't need to provide the authentication server URL, username, or password to the adapter
-library itself. To achieve this, follow the instructions printed on the screen after running ``iqmclient auth login``.
-Namely, set the ``IQM_TOKENS_FILE`` environment variable to point to your tokens file.
-
-On Linux:
-
-.. code-block:: bash
-
-  $ export IQM_TOKENS_FILE=/home/<username>/tokens.json
-
-On Windows:
-
-.. code-block:: batch
-
-  set IQM_TOKENS_FILE=C:\Users\<username>\.cache\iqm-client-cli\tokens.json
-
-Once set, this environment variable is read by the instance of IQM Client associated with the adapter. As a result,
-from the point of view of the adapter it looks like authentication is simply not required (i.e. no
-authentication-related information has to be provided to the adapter).
-
-Status
-^^^^^^
-
-To see the current status of the token manager, use:
-
-.. code-block:: bash
-
-  $ iqmclient auth status
-
-If the tokens file exists, ``iqmclient auth status`` will report whether the corresponding token
-manager is running. It will also print the time of the last successful refresh request, and
-how much time is left until current tokens expire.
-
-See ``iqmclient auth status --help`` for more details.
-
-Logout
-^^^^^^
-
-To log out, run
-
-.. code-block:: bash
-
-  $ iqmclient auth logout
-
-This will send a logout request to the authentication server, kill the token manager daemon (if any), and delete the
-tokens file.
-
-You may want to stop the token manager, but maintain the session on the server and keep the tokens file intact.
-To do so, run:
-
-.. code-block:: bash
-
-  $ iqmclient auth logout --keep-tokens
-
-See ``iqmclient auth logout --help`` for more details.
-
-Multiple configuration files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-By default, all IQM Client CLI commands read the configuration file from the default location
-``~/.config/iqm-client-cli/config.json``. You can specify a different filepath by providing the ``--config-file`` value,
-for example:
-
-.. code-block:: bash
-
-  $ iqmclient auth status --config-file /home/joe/config.json
-  $ iqmclient auth login --config-file /home/joe/config.json
-  $ iqmclient auth logout --config-file /home/joe/config.json

iqm_client-31.8.0/src/iqm/iqm_client/cli/__init__.py

@@ -1,14 +0,0 @@
-# Copyright 2021-2023 IQM client developers
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Command-line interface (CLI) for managing user authentication when using IQM quantum computers."""

iqm_client-31.8.0/src/iqm/iqm_client/cli/auth.py

@@ -1,168 +0,0 @@
-# Copyright 2021-2023 IQM client developers
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""Authorization and session management for IQM Client CLI."""
-
-from base64 import b64decode
-from enum import Enum
-import json
-import time
-
-from pydantic import BaseModel, Field
-import requests
-
-REFRESH_MARGIN_SECONDS = 15
-AUTH_REQUESTS_TIMEOUT = 20
-
-
-class ClientAuthenticationError(RuntimeError):
-    """Something went wrong with user authentication."""
-
-
-class ClientAccountSetupError(RuntimeError):
-    """User's account has not been fully set up yet."""
-
-
-class GrantType(str, Enum):
-    """Type of token request."""
-
-    PASSWORD = "password"
-    REFRESH = "refresh_token"
-
-
-class AuthRequest(BaseModel):
-    """Request sent to authentication server for access token and refresh token, or for terminating the session.
-
-    * Token request with grant type ``'password'`` starts a new session in the authentication server.
-      It uses fields ``client_id``, ``grant_type``, ``username`` and ``password``.
-    * Token request with grant type ``'refresh_token'`` is used for maintaining an existing session.
-      It uses field ``client_id``, ``grant_type``, ``refresh_token``.
-    * Logout request uses only fields ``client_id`` and ``refresh_token``.
-    """
-
-    client_id: str = Field(...)
-    "name of the client for all request types"
-    grant_type: GrantType | None = Field(None)
-    "type of token request, in ``{'password', 'refresh_token'}``"
-    username: str | None = Field(None)
-    "username for grant type ``'password'``"
-    password: str | None = Field(None)
-    "password for grant type ``'password'``"
-    refresh_token: str | None = Field(None)
-    "refresh token for grant type ``'refresh_token'`` and logout request"
-
-
-def slash_join(a: str, b: str) -> str:
-    """Join two URL segments together, ensuring a single slash between them."""
-    return a.rstrip("/") + "/" + b.lstrip("/")
-
-
-def login_request(url: str, realm: str, client_id: str, username: str, password: str) -> dict[str, str]:
-    """Sends login request to the authentication server.
-
-    Raises:
-        ClientAuthenticationError: obtaining the tokens failed
-
-    Returns:
-        Tokens dictionary
-
-    """
-    data = AuthRequest(
-        client_id=client_id, grant_type=GrantType.PASSWORD, username=username, password=password, refresh_token=None
-    )
-
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/token")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-    if result.status_code == 404:
-        raise ClientAuthenticationError(f"token endpoint is not available at {url}")
-    if result.status_code == 400 and result.json().get("error_description", "") == "Account is not fully set up":
-        raise ClientAccountSetupError("Account is not fully set up")
-    if result.status_code != 200:
-        raise ClientAuthenticationError("invalid username and/or password")
-    tokens = result.json()
-    tokens = {key: tokens.get(key, "") for key in ["access_token", "refresh_token"]}
-    return tokens
-
-
-def refresh_request(url: str, realm: str, client_id: str, refresh_token: str) -> dict[str, str] | None:
-    """Sends refresh request to the authentication server.
-
-    Raises:
-        Timeout: no response from auth server within the timeout period
-        ConnectionError: connecting the auth server failed on all retries
-        ClientAuthenticationError: updating the tokens failed
-
-    Returns:
-        Tokens dictionary, or None if refresh_token is expired.
-
-    """
-    if not token_is_valid(refresh_token):
-        raise ClientAuthenticationError("Refresh token has expired")
-
-    # Update tokens using existing refresh_token
-    data = AuthRequest(
-        client_id=client_id, grant_type=GrantType.REFRESH, username=None, password=None, refresh_token=refresh_token
-    )
-
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/token")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-    if result.status_code != 200:
-        raise ClientAuthenticationError(f"Failed to update tokens, {result.text}")
-    tokens = result.json()
-    if not tokens or "access_token" not in tokens or "refresh_token" not in tokens:
-        raise ClientAuthenticationError("Failed to get new tokens")
-    tokens = {key: tokens.get(key, "") for key in ["access_token", "refresh_token"]}
-    return tokens
-
-
-def logout_request(url: str, realm: str, client_id: str, refresh_token: str) -> bool:
-    """Sends logout request to the authentication server.
-
-    Raises:
-        ClientAuthenticationError: updating the tokens failed
-
-    Returns:
-        True if logout was successful
-
-    """
-    data = AuthRequest(client_id=client_id, grant_type=None, username=None, password=None, refresh_token=refresh_token)
-    request_url = slash_join(url, f"realms/{realm}/protocol/openid-connect/logout")
-    result = requests.post(request_url, data=data.model_dump(exclude_none=True), timeout=AUTH_REQUESTS_TIMEOUT)
-
-    if result.status_code != 204:
-        raise ClientAuthenticationError(f"Failed to logout, {result.text}")
-    return True
-
-
-def time_left_seconds(token: str) -> int:
-    """Check how much time is left until the token expires.
-
-    Returns:
-        Time left on token in seconds.
-
-    """
-    _, body, _ = token.split(".", 2)
-    # Add padding to adjust body length to a multiple of 4 chars as required by base64 decoding
-    body += "=" * (-len(body) % 4)
-    exp_time = int(json.loads(b64decode(body)).get("exp", "0"))
-    return max(0, exp_time - int(time.time()))
-
-
-def token_is_valid(refresh_token: str) -> bool:
-    """Check if token is not about to expire.
-
-    Returns:
-        True if token is still valid, False otherwise.
-
-    """
-    return time_left_seconds(refresh_token) > REFRESH_MARGIN_SECONDS