seerr.AuthApi

All URIs are relative to http://localhost:5055/api/v1

Method	HTTP request	Description
create_auth_jellyfin	POST /auth/jellyfin	Sign in using a Jellyfin username and password
create_auth_jellyfin_quickconnect_authenticate	POST /auth/jellyfin/quickconnect/authenticate	Authenticate with Quick Connect
create_auth_jellyfin_quickconnect_initiate	POST /auth/jellyfin/quickconnect/initiate	Initiate Jellyfin Quick Connect
create_auth_local	POST /auth/local	Sign in using a local account
create_auth_logout	POST /auth/logout	Sign out and clear session cookie
create_auth_plex	POST /auth/plex	Sign in using a Plex token
get_auth_jellyfin_quickconnect_check	GET /auth/jellyfin/quickconnect/check	Check Quick Connect authorization status
get_auth_me	GET /auth/me	Get logged-in user

create_auth_jellyfin

User create_auth_jellyfin(create_auth_jellyfin_request)

Takes the user's username and password to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the Jellyfin server, they will also have an account created, but without any permissions.

Example

import seerr
from seerr.models.create_auth_jellyfin_request import CreateAuthJellyfinRequest
from seerr.models.user import User
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)
    create_auth_jellyfin_request = seerr.CreateAuthJellyfinRequest() # CreateAuthJellyfinRequest | 

    try:
        # Sign in using a Jellyfin username and password
        api_response = api_instance.create_auth_jellyfin(create_auth_jellyfin_request)
        print("The response of AuthApi->create_auth_jellyfin:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_jellyfin: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_auth_jellyfin_request	CreateAuthJellyfinRequest

Return type

User

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_auth_jellyfin_quickconnect_authenticate

User create_auth_jellyfin_quickconnect_authenticate(create_auth_jellyfin_quickconnect_authenticate_request)

Authenticate with Quick Connect

Completes the Quick Connect authentication flow and creates a user session.

Example

import seerr
from seerr.models.create_auth_jellyfin_quickconnect_authenticate_request import CreateAuthJellyfinQuickconnectAuthenticateRequest
from seerr.models.user import User
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)
    create_auth_jellyfin_quickconnect_authenticate_request = seerr.CreateAuthJellyfinQuickconnectAuthenticateRequest() # CreateAuthJellyfinQuickconnectAuthenticateRequest | 

    try:
        # Authenticate with Quick Connect
        api_response = api_instance.create_auth_jellyfin_quickconnect_authenticate(create_auth_jellyfin_quickconnect_authenticate_request)
        print("The response of AuthApi->create_auth_jellyfin_quickconnect_authenticate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_jellyfin_quickconnect_authenticate: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_auth_jellyfin_quickconnect_authenticate_request	CreateAuthJellyfinQuickconnectAuthenticateRequest

Return type

User

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
403	Quick Connect not authorized or access denied	-
500	Authentication failed	-
2XX	Successfully authenticated	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_auth_jellyfin_quickconnect_initiate

CreateAuthJellyfinQuickconnectInitiate2XXResponse create_auth_jellyfin_quickconnect_initiate()

Initiate Jellyfin Quick Connect

Initiates a Quick Connect session and returns a code for the user to authorize on their Jellyfin server.

Example

import seerr
from seerr.models.create_auth_jellyfin_quickconnect_initiate2_xx_response import CreateAuthJellyfinQuickconnectInitiate2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)

    try:
        # Initiate Jellyfin Quick Connect
        api_response = api_instance.create_auth_jellyfin_quickconnect_initiate()
        print("The response of AuthApi->create_auth_jellyfin_quickconnect_initiate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_jellyfin_quickconnect_initiate: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CreateAuthJellyfinQuickconnectInitiate2XXResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
500	Failed to initiate Quick Connect	-
2XX	Quick Connect session initiated	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_auth_local

User create_auth_local(create_auth_local_request)

Takes an email and a password to log the user in. Generates a session cookie for use in further requests.

Example

import seerr
from seerr.models.create_auth_local_request import CreateAuthLocalRequest
from seerr.models.user import User
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)
    create_auth_local_request = seerr.CreateAuthLocalRequest() # CreateAuthLocalRequest | 

    try:
        # Sign in using a local account
        api_response = api_instance.create_auth_local(create_auth_local_request)
        print("The response of AuthApi->create_auth_local:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_local: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_auth_local_request	CreateAuthLocalRequest

Return type

User

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_auth_logout

CreateAuthLogout2XXResponse create_auth_logout()

Sign out and clear session cookie

Completely clear the session cookie and associated values, effectively signing the user out.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.create_auth_logout2_xx_response import CreateAuthLogout2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)

    try:
        # Sign out and clear session cookie
        api_response = api_instance.create_auth_logout()
        print("The response of AuthApi->create_auth_logout:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_logout: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CreateAuthLogout2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_auth_plex

User create_auth_plex(create_auth_plex_request)

Takes an authToken (Plex token) to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the main Plex server, they will also have an account created, but without any permissions.

Example

import seerr
from seerr.models.create_auth_plex_request import CreateAuthPlexRequest
from seerr.models.user import User
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)
    create_auth_plex_request = seerr.CreateAuthPlexRequest() # CreateAuthPlexRequest | 

    try:
        # Sign in using a Plex token
        api_response = api_instance.create_auth_plex(create_auth_plex_request)
        print("The response of AuthApi->create_auth_plex:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->create_auth_plex: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_auth_plex_request	CreateAuthPlexRequest

Return type

User

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_auth_jellyfin_quickconnect_check

GetAuthJellyfinQuickconnectCheck2XXResponse get_auth_jellyfin_quickconnect_check(secret)

Check Quick Connect authorization status

Checks if the Quick Connect code has been authorized by the user.

Example

import seerr
from seerr.models.get_auth_jellyfin_quickconnect_check2_xx_response import GetAuthJellyfinQuickconnectCheck2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)
    secret = 'secret_example' # str | The secret returned from the initiate endpoint

    try:
        # Check Quick Connect authorization status
        api_response = api_instance.get_auth_jellyfin_quickconnect_check(secret)
        print("The response of AuthApi->get_auth_jellyfin_quickconnect_check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->get_auth_jellyfin_quickconnect_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
secret	str	The secret returned from the initiate endpoint

Return type

GetAuthJellyfinQuickconnectCheck2XXResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
404	Quick Connect session not found or expired	-
2XX	Authorization status returned	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_auth_me

User get_auth_me()

Get logged-in user

Returns the currently logged-in user.

Example

Api Key Authentication (apiKey):
Api Key Authentication (cookieAuth):

import seerr
from seerr.models.user import User
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.AuthApi(api_client)

    try:
        # Get logged-in user
        api_response = api_instance.get_auth_me()
        print("The response of AuthApi->get_auth_me:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AuthApi->get_auth_me: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Object containing the logged-in user in JSON	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

AuthApi.md

Latest commit

History

AuthApi.md

File metadata and controls

seerr.AuthApi

create_auth_jellyfin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_jellyfin_quickconnect_authenticate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_jellyfin_quickconnect_initiate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_local

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_logout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_plex

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_auth_jellyfin_quickconnect_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_auth_me

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details