Source code for dioptra.client.auth

# This Software (Dioptra) is being made available as a public service by the
# National Institute of Standards and Technology (NIST), an Agency of the United
# States Department of Commerce. This software was developed in part by employees of
# NIST and in part by NIST contractors. Copyright in portions of this software that
# were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
# to Title 17 United States Code Section 105, works of NIST employees are not
# subject to copyright protection in the United States. However, NIST may hold
# international copyright in software created by its employees and domestic
# copyright (or licensing rights) in portions of software that were assigned or
# licensed to NIST. To the extent that NIST holds copyright in this software, it is
# being made available under the Creative Commons Attribution 4.0 International
# license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
# of the software developed or licensed by NIST.
#
# ACCESS THE FULL CC BY 4.0 LICENSE HERE:
# https://creativecommons.org/licenses/by/4.0/legalcode
from typing import ClassVar, TypeVar

from .base import CollectionClient

T = TypeVar("T")


class AuthCollectionClient(CollectionClient[T]):
    """The client for managing Dioptra's /auth collection.

    Attributes:
        name: The name of the collection.
    """

    name: ClassVar[str] = "auth"

    def login(self, username: str, password: str) -> T:
        """Send a login request to the Dioptra API.

        Args:
            username: The username of the user.
            password: The password of the user.

        Returns:
            The response from the Dioptra API.
        """
        return self._session.post(
            self.url,
            "login",
            json_={"username": username, "password": password},
        )

    def logout(self, everywhere: bool = False) -> T:
        """Send a logout request to the Dioptra API.

        Args:
            everywhere: If True, log out from all sessions.

        Returns:
            The response from the Dioptra API.
        """
        return self._session.post(self.url, "logout", params={"everywhere": everywhere})