AccessNamespace

pymoonraker.api.AccessNamespace

User authentication and API key management.

Auto-generated from schema/moonraker_api.yaml.

Source code in src/pymoonraker/api/_generated.py

class AccessNamespace:
    """User authentication and API key management.

    Auto-generated from schema/moonraker_api.yaml.
    """

    def __init__(self, client: MoonrakerClient) -> None:
        self._client = client

    async def login(self, username: str, password: str) -> AccessLoginResponse:
        """Authenticate with username and password.

        Args:
            username: Username
            password: Password

        """
        params: dict[str, Any] = {}
        params["username"] = username
        params["password"] = password
        raw = await self._client.call("access.login", params)
        return AccessLoginResponse.model_validate(raw)

    async def logout(self) -> AccessLogoutResponse:
        """Invalidate current session."""
        raw = await self._client.call("access.logout")
        return AccessLogoutResponse.model_validate(raw)

    async def get_user(self) -> AccessUserInfo:
        """Get current authenticated user info."""
        raw = await self._client.call("access.get_user")
        return AccessUserInfo.model_validate(raw)

    async def list_users(self) -> AccessUsersListResponse:
        """List all registered users."""
        raw = await self._client.call("access.users.list")
        return AccessUsersListResponse.model_validate(raw)

    async def refresh_jwt(self, refresh_token: str) -> AccessRefreshJwtResponse:
        """Refresh an expired JWT access token.

        Args:
            refresh_token: Refresh token from login

        """
        params: dict[str, Any] = {}
        params["refresh_token"] = refresh_token
        raw = await self._client.call("access.refresh_jwt", params)
        return AccessRefreshJwtResponse.model_validate(raw)

    async def get_api_key(self) -> str:
        """Get the current API key."""
        raw = await self._client.call("access.api_key")
        return cast("str", raw)

    async def oneshot_token(self) -> str:
        """Generate a single-use authentication token."""
        raw = await self._client.call("access.oneshot_token")
        return cast("str", raw)

get_api_key async

get_api_key() -> str

Get the current API key.

Source code in src/pymoonraker/api/_generated.py

async def get_api_key(self) -> str:
    """Get the current API key."""
    raw = await self._client.call("access.api_key")
    return cast("str", raw)

get_user async

get_user() -> AccessUserInfo

Get current authenticated user info.

Source code in src/pymoonraker/api/_generated.py

async def get_user(self) -> AccessUserInfo:
    """Get current authenticated user info."""
    raw = await self._client.call("access.get_user")
    return AccessUserInfo.model_validate(raw)

list_users async

list_users() -> AccessUsersListResponse

List all registered users.

Source code in src/pymoonraker/api/_generated.py

async def list_users(self) -> AccessUsersListResponse:
    """List all registered users."""
    raw = await self._client.call("access.users.list")
    return AccessUsersListResponse.model_validate(raw)

login async

login(username: str, password: str) -> AccessLoginResponse

Authenticate with username and password.

Parameters:

Name	Type	Description	Default
username	str	Username	required
password	str	Password	required

Source code in src/pymoonraker/api/_generated.py

async def login(self, username: str, password: str) -> AccessLoginResponse:
    """Authenticate with username and password.

    Args:
        username: Username
        password: Password

    """
    params: dict[str, Any] = {}
    params["username"] = username
    params["password"] = password
    raw = await self._client.call("access.login", params)
    return AccessLoginResponse.model_validate(raw)

logout async

logout() -> AccessLogoutResponse

Invalidate current session.

Source code in src/pymoonraker/api/_generated.py

async def logout(self) -> AccessLogoutResponse:
    """Invalidate current session."""
    raw = await self._client.call("access.logout")
    return AccessLogoutResponse.model_validate(raw)

oneshot_token async

oneshot_token() -> str

Generate a single-use authentication token.

Source code in src/pymoonraker/api/_generated.py

async def oneshot_token(self) -> str:
    """Generate a single-use authentication token."""
    raw = await self._client.call("access.oneshot_token")
    return cast("str", raw)

refresh_jwt async

refresh_jwt(refresh_token: str) -> AccessRefreshJwtResponse

Refresh an expired JWT access token.

Parameters:

Name	Type	Description	Default
refresh_token	str	Refresh token from login	required

Source code in src/pymoonraker/api/_generated.py

async def refresh_jwt(self, refresh_token: str) -> AccessRefreshJwtResponse:
    """Refresh an expired JWT access token.

    Args:
        refresh_token: Refresh token from login

    """
    params: dict[str, Any] = {}
    params["refresh_token"] = refresh_token
    raw = await self._client.call("access.refresh_jwt", params)
    return AccessRefreshJwtResponse.model_validate(raw)