Authentication#

class qbittorrentapi.auth.AuthAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: qbittorrentapi.request.Request

Implementation of all Authorization API methods.

Usage

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> _ = client.is_logged_in
>>> client.auth_log_in(username='admin', password='adminadmin')
>>> client.auth_log_out()

auth_log_in(username=None, password=None, **kwargs)#

Raises

LoginFailed – if credentials failed to log in
Forbidden403Error – if user is banned…or not logged in

Parameters

username – username for qBittorrent client
password – password for qBittorrent client

Returns

None

auth_log_out(**kwargs)#: End session with qBittorrent.

property is_logged_in#

Returns True/False for whether a log-in attempt was ever successfully completed.

It isn’t possible to know if qBittorrent will accept whatever SID is locally cached…however, any request that is rejected because of the SID will be automatically retried after a new SID is requested.

Returns: True/False for whether a log-in attempt was previously completed

class qbittorrentapi.auth.Authorization(*args, **kwargs)#

Allows interaction with the Authorization API endpoints.

Usage

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> is_logged_in = client.auth.is_logged_in
>>> client.auth.log_in(username='admin', password='adminadmin')
>>> client.auth.log_out()

property is_logged_in#: Implements is_logged_in()

log_in(username=None, password=None, **kwargs)#: Implements auth_log_in()

log_out(**kwargs)#: Implements auth_log_out()