jellyfin.generated.api_10_10.QuickConnectApi

All URIs are relative to http://localhost

Method	HTTP request	Description
authorize_quick_connect	POST /QuickConnect/Authorize	Authorizes a pending quick connect request.
get_quick_connect_enabled	GET /QuickConnect/Enabled	Gets the current quick connect state.
get_quick_connect_state	GET /QuickConnect/Connect	Attempts to retrieve authentication information.
initiate_quick_connect	POST /QuickConnect/Initiate	Initiate a new quick connect request.

authorize_quick_connect

bool authorize_quick_connect(code, user_id=user_id)

Authorizes a pending quick connect request.

Example

Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

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

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.QuickConnectApi(api_client)
    code = 'code_example' # str | Quick connect code to authorize.
    user_id = 'user_id_example' # str | The user the authorize. Access to the requested user is required. (optional)

    try:
        # Authorizes a pending quick connect request.
        api_response = api_instance.authorize_quick_connect(code, user_id=user_id)
        print("The response of QuickConnectApi->authorize_quick_connect:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuickConnectApi->authorize_quick_connect: %s\n" % e)

Parameters

Name	Type	Description	Notes
code	str	Quick connect code to authorize.
user_id	str	The user the authorize. Access to the requested user is required.	[optional]

Return type

bool

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Quick connect result authorized successfully.	-
401	Unauthorized	-
403	Unknown user id.	-

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

get_quick_connect_enabled

bool get_quick_connect_enabled()

Gets the current quick connect state.

Example

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

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

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.QuickConnectApi(api_client)

    try:
        # Gets the current quick connect state.
        api_response = api_instance.get_quick_connect_enabled()
        print("The response of QuickConnectApi->get_quick_connect_enabled:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuickConnectApi->get_quick_connect_enabled: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

bool

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Quick connect state returned.	-

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

get_quick_connect_state

QuickConnectResult get_quick_connect_state(secret)

Attempts to retrieve authentication information.

Example

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.models.quick_connect_result import QuickConnectResult
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

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

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.QuickConnectApi(api_client)
    secret = 'secret_example' # str | Secret previously returned from the Initiate endpoint.

    try:
        # Attempts to retrieve authentication information.
        api_response = api_instance.get_quick_connect_state(secret)
        print("The response of QuickConnectApi->get_quick_connect_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuickConnectApi->get_quick_connect_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
secret	str	Secret previously returned from the Initiate endpoint.

Return type

QuickConnectResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Quick connect result returned.	-
404	Unknown quick connect secret.	-

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

initiate_quick_connect

QuickConnectResult initiate_quick_connect()

Initiate a new quick connect request.

Example

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.models.quick_connect_result import QuickConnectResult
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

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

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.QuickConnectApi(api_client)

    try:
        # Initiate a new quick connect request.
        api_response = api_instance.initiate_quick_connect()
        print("The response of QuickConnectApi->initiate_quick_connect:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling QuickConnectApi->initiate_quick_connect: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

QuickConnectResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Quick connect request successfully created.	-
401	Quick connect is not active on this server.	-

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