flexget.api.core.authentication module#

class flexget.api.core.authentication.LoginAPI(api, *args, **kwargs)[source]#

Bases: APIResource

Parameters:

api (RestxAPI)

mediatypes()#
post(session=None)[source]#

Login with username and password.

Parameters:

session (Session)

Return type:

Response

endpoint = 'auth_login_api'#
methods: ClassVar[Collection[str] | None] = {'POST'}#

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class flexget.api.core.authentication.LogoutAPI(api, *args, **kwargs)[source]#

Bases: APIResource

Parameters:

api (RestxAPI)

mediatypes()#
post(session=None)[source]#

Logout and clear session cookies.

Parameters:

session (Session)

Return type:

Response

endpoint = 'auth_logout_api'#
methods: ClassVar[Collection[str] | None] = {'POST'}#

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

flexget.api.core.authentication.check_valid_login()[source]#
Return type:

Response | None