seerr.UsersApi

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

Method	HTTP request	Description
create_auth_reset_password	POST /auth/reset-password	Send a reset password email
create_auth_reset_password_by_guid	POST /auth/reset-password/{guid}	Reset the password for a user
create_user	POST /user	Create new user
create_user_import_from_jellyfin	POST /user/import-from-jellyfin	Import all users from Jellyfin
create_user_import_from_plex	POST /user/import-from-plex	Import all users from Plex
create_user_register_push_subscription	POST /user/registerPushSubscription	Register a web push /user/registerPushSubscription
create_user_settings_linked_accounts_jellyfin	POST /user/{userId}/settings/linked-accounts/jellyfin	Link the provided Jellyfin account to the current user
create_user_settings_linked_accounts_jellyfin_quickconnect	POST /user/{userId}/settings/linked-accounts/jellyfin/quickconnect	Link Jellyfin/Emby account with Quick Connect
create_user_settings_linked_accounts_plex	POST /user/{userId}/settings/linked-accounts/plex	Link the provided Plex account to the current user
create_user_settings_main	POST /user/{userId}/settings/main	Update general settings for a user
create_user_settings_notifications	POST /user/{userId}/settings/notifications	Update notification settings for a user
create_user_settings_password	POST /user/{userId}/settings/password	Update password for a user
create_user_settings_permissions	POST /user/{userId}/settings/permissions	Update permission settings for a user
delete_user	DELETE /user/{userId}	Delete user by ID
delete_user_push_subscription	DELETE /user/{userId}/pushSubscription/{endpoint}	Delete user push subscription by key
delete_user_settings_linked_accounts_jellyfin	DELETE /user/{userId}/settings/linked-accounts/jellyfin	Remove the linked Jellyfin account for a user
delete_user_settings_linked_accounts_plex	DELETE /user/{userId}/settings/linked-accounts/plex	Remove the linked Plex account for a user
get_user	GET /user	Get all users
get_user_by_user_id	GET /user/{userId}	Get user by ID
get_user_jellyfin_by_jellyfin_user_id	GET /user/jellyfin/{jellyfinUserId}	Get user by Jellyfin user ID
get_user_push_subscription_by_endpoint	GET /user/{userId}/pushSubscription/{endpoint}	Get web push notification settings for a user
get_user_push_subscriptions	GET /user/{userId}/pushSubscriptions	Get all web push notification settings for a user
get_user_quota	GET /user/{userId}/quota	Get quotas for a specific user
get_user_requests	GET /user/{userId}/requests	Get requests for a specific user
get_user_settings_main	GET /user/{userId}/settings/main	Get general settings for a user
get_user_settings_notifications	GET /user/{userId}/settings/notifications	Get notification settings for a user
get_user_settings_password	GET /user/{userId}/settings/password	Get password page informatiom
get_user_settings_permissions	GET /user/{userId}/settings/permissions	Get permission settings for a user
get_user_watch_data	GET /user/{userId}/watch_data	Get watch data
get_user_watchlist	GET /user/{userId}/watchlist	Get the Plex watchlist for a specific user
put_user	PUT /user	Update batch of users
update_user	PUT /user/{userId}	Update a user by user ID

create_auth_reset_password

CreateAuthLogout2XXResponse create_auth_reset_password(create_auth_reset_password_request)

Send a reset password email

Sends a reset password email to the email if the user exists

Example

import seerr
from seerr.models.create_auth_logout2_xx_response import CreateAuthLogout2XXResponse
from seerr.models.create_auth_reset_password_request import CreateAuthResetPasswordRequest
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.UsersApi(api_client)
    create_auth_reset_password_request = seerr.CreateAuthResetPasswordRequest() # CreateAuthResetPasswordRequest | 

    try:
        # Send a reset password email
        api_response = api_instance.create_auth_reset_password(create_auth_reset_password_request)
        print("The response of UsersApi->create_auth_reset_password:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_auth_reset_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_auth_reset_password_request	CreateAuthResetPasswordRequest

Return type

CreateAuthLogout2XXResponse

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_reset_password_by_guid

CreateAuthLogout2XXResponse create_auth_reset_password_by_guid(guid, create_auth_reset_password_by_guid_request)

Reset the password for a user

Resets the password for a user if the given guid is connected to a user

Example

import seerr
from seerr.models.create_auth_logout2_xx_response import CreateAuthLogout2XXResponse
from seerr.models.create_auth_reset_password_by_guid_request import CreateAuthResetPasswordByGuidRequest
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.UsersApi(api_client)
    guid = '9afef5a7-ec89-4d5f-9397-261e96970b50' # str | 
    create_auth_reset_password_by_guid_request = seerr.CreateAuthResetPasswordByGuidRequest() # CreateAuthResetPasswordByGuidRequest | 

    try:
        # Reset the password for a user
        api_response = api_instance.create_auth_reset_password_by_guid(guid, create_auth_reset_password_by_guid_request)
        print("The response of UsersApi->create_auth_reset_password_by_guid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_auth_reset_password_by_guid: %s\n" % e)

Parameters

Name	Type	Description	Notes
guid	str
create_auth_reset_password_by_guid_request	CreateAuthResetPasswordByGuidRequest

Return type

CreateAuthLogout2XXResponse

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_user

User create_user(create_user_request)

Create new user

Creates a new user. Requires the MANAGE_USERS permission.

Example

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

import seerr
from seerr.models.create_user_request import CreateUserRequest
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.UsersApi(api_client)
    create_user_request = seerr.CreateUserRequest() # CreateUserRequest | 

    try:
        # Create new user
        api_response = api_instance.create_user(create_user_request)
        print("The response of UsersApi->create_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_user_request	CreateUserRequest

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	The created user	-

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

create_user_import_from_jellyfin

List[User] create_user_import_from_jellyfin(create_user_import_from_jellyfin_request=create_user_import_from_jellyfin_request)

Import all users from Jellyfin

Fetches and imports users from the Jellyfin server.

Requires the MANAGE_USERS permission.

Example

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

import seerr
from seerr.models.create_user_import_from_jellyfin_request import CreateUserImportFromJellyfinRequest
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.UsersApi(api_client)
    create_user_import_from_jellyfin_request = seerr.CreateUserImportFromJellyfinRequest() # CreateUserImportFromJellyfinRequest |  (optional)

    try:
        # Import all users from Jellyfin
        api_response = api_instance.create_user_import_from_jellyfin(create_user_import_from_jellyfin_request=create_user_import_from_jellyfin_request)
        print("The response of UsersApi->create_user_import_from_jellyfin:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_import_from_jellyfin: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_user_import_from_jellyfin_request	CreateUserImportFromJellyfinRequest		[optional]

Return type

List[User]

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	A list of the newly created users	-

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

create_user_import_from_plex

List[User] create_user_import_from_plex(create_user_import_from_plex_request=create_user_import_from_plex_request)

Import all users from Plex

Fetches and imports users from the Plex server. If a list of Plex IDs is provided in the request body, only the specified users will be imported. Otherwise, all users will be imported.

Requires the MANAGE_USERS permission.

Example

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

import seerr
from seerr.models.create_user_import_from_plex_request import CreateUserImportFromPlexRequest
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.UsersApi(api_client)
    create_user_import_from_plex_request = seerr.CreateUserImportFromPlexRequest() # CreateUserImportFromPlexRequest |  (optional)

    try:
        # Import all users from Plex
        api_response = api_instance.create_user_import_from_plex(create_user_import_from_plex_request=create_user_import_from_plex_request)
        print("The response of UsersApi->create_user_import_from_plex:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_import_from_plex: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_user_import_from_plex_request	CreateUserImportFromPlexRequest		[optional]

Return type

List[User]

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	A list of the newly created users	-

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

create_user_register_push_subscription

create_user_register_push_subscription(create_user_register_push_subscription_request)

Registers a web push subscription for the logged-in user

Example

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

import seerr
from seerr.models.create_user_register_push_subscription_request import CreateUserRegisterPushSubscriptionRequest
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.UsersApi(api_client)
    create_user_register_push_subscription_request = seerr.CreateUserRegisterPushSubscriptionRequest() # CreateUserRegisterPushSubscriptionRequest | 

    try:
        # Register a web push /user/registerPushSubscription
        api_instance.create_user_register_push_subscription(create_user_register_push_subscription_request)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_register_push_subscription: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_user_register_push_subscription_request	CreateUserRegisterPushSubscriptionRequest

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successfully registered push subscription	-

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

create_user_settings_linked_accounts_jellyfin

create_user_settings_linked_accounts_jellyfin(user_id, create_user_settings_linked_accounts_jellyfin_request)

Link the provided Jellyfin account to the current user

Logs in to Jellyfin with the provided credentials, then links the associated Jellyfin account with the user's account. Users can only link external accounts to their own account.

Example

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

import seerr
from seerr.models.create_user_settings_linked_accounts_jellyfin_request import CreateUserSettingsLinkedAccountsJellyfinRequest
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    create_user_settings_linked_accounts_jellyfin_request = seerr.CreateUserSettingsLinkedAccountsJellyfinRequest() # CreateUserSettingsLinkedAccountsJellyfinRequest | 

    try:
        # Link the provided Jellyfin account to the current user
        api_instance.create_user_settings_linked_accounts_jellyfin(user_id, create_user_settings_linked_accounts_jellyfin_request)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_linked_accounts_jellyfin: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
create_user_settings_linked_accounts_jellyfin_request	CreateUserSettingsLinkedAccountsJellyfinRequest

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Linking account succeeded	-
403	Invalid credentials	-
422	Account already linked to a user	-

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

create_user_settings_linked_accounts_jellyfin_quickconnect

create_user_settings_linked_accounts_jellyfin_quickconnect(user_id, create_auth_jellyfin_quickconnect_authenticate_request)

Link Jellyfin/Emby account with Quick Connect

Links a Jellyfin/Emby account to the user's profile using Quick Connect authentication

Example

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

import seerr
from seerr.models.create_auth_jellyfin_quickconnect_authenticate_request import CreateAuthJellyfinQuickconnectAuthenticateRequest
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    create_auth_jellyfin_quickconnect_authenticate_request = seerr.CreateAuthJellyfinQuickconnectAuthenticateRequest() # CreateAuthJellyfinQuickconnectAuthenticateRequest | 

    try:
        # Link Jellyfin/Emby account with Quick Connect
        api_instance.create_user_settings_linked_accounts_jellyfin_quickconnect(user_id, create_auth_jellyfin_quickconnect_authenticate_request)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_linked_accounts_jellyfin_quickconnect: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
create_auth_jellyfin_quickconnect_authenticate_request	CreateAuthJellyfinQuickconnectAuthenticateRequest

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid Quick Connect secret	-
204	Account successfully linked	-
401	Unauthorized	-
422	Account already linked	-
500	Server error	-

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

create_user_settings_linked_accounts_plex

create_user_settings_linked_accounts_plex(user_id, create_auth_plex_request)

Link the provided Plex account to the current user

Logs in to Plex with the provided auth token, then links the associated Plex account with the user's account. Users can only link external accounts to their own account.

Example

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

import seerr
from seerr.models.create_auth_plex_request import CreateAuthPlexRequest
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    create_auth_plex_request = seerr.CreateAuthPlexRequest() # CreateAuthPlexRequest | 

    try:
        # Link the provided Plex account to the current user
        api_instance.create_user_settings_linked_accounts_plex(user_id, create_auth_plex_request)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_linked_accounts_plex: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
create_auth_plex_request	CreateAuthPlexRequest

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Linking account succeeded	-
403	Invalid credentials	-
422	Account already linked to a user	-

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

create_user_settings_main

UserSettings create_user_settings_main(user_id, user_settings)

Update general settings for a user

Updates and returns general settings for a specific user. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
from seerr.models.user_settings import UserSettings
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    user_settings = seerr.UserSettings() # UserSettings | 

    try:
        # Update general settings for a user
        api_response = api_instance.create_user_settings_main(user_id, user_settings)
        print("The response of UsersApi->create_user_settings_main:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_main: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
user_settings	UserSettings

Return type

UserSettings

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Updated user general settings returned	-

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

create_user_settings_notifications

UserSettingsNotifications create_user_settings_notifications(user_id, user_settings_notifications)

Update notification settings for a user

Updates and returns notification settings for a specific user. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
from seerr.models.user_settings_notifications import UserSettingsNotifications
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    user_settings_notifications = seerr.UserSettingsNotifications() # UserSettingsNotifications | 

    try:
        # Update notification settings for a user
        api_response = api_instance.create_user_settings_notifications(user_id, user_settings_notifications)
        print("The response of UsersApi->create_user_settings_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_notifications: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
user_settings_notifications	UserSettingsNotifications

Return type

UserSettingsNotifications

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Updated user notification settings returned	-

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

create_user_settings_password

create_user_settings_password(user_id, create_user_settings_password_request)

Update password for a user

Updates a user's password. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
from seerr.models.create_user_settings_password_request import CreateUserSettingsPasswordRequest
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    create_user_settings_password_request = seerr.CreateUserSettingsPasswordRequest() # CreateUserSettingsPasswordRequest | 

    try:
        # Update password for a user
        api_instance.create_user_settings_password(user_id, create_user_settings_password_request)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
create_user_settings_password_request	CreateUserSettingsPasswordRequest

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	User password updated	-

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

create_user_settings_permissions

GetUserSettingsPermissions2XXResponse create_user_settings_permissions(user_id, create_user_settings_permissions_request)

Update permission settings for a user

Updates and returns permission settings for a specific user. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
from seerr.models.create_user_settings_permissions_request import CreateUserSettingsPermissionsRequest
from seerr.models.get_user_settings_permissions2_xx_response import GetUserSettingsPermissions2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    create_user_settings_permissions_request = seerr.CreateUserSettingsPermissionsRequest() # CreateUserSettingsPermissionsRequest | 

    try:
        # Update permission settings for a user
        api_response = api_instance.create_user_settings_permissions(user_id, create_user_settings_permissions_request)
        print("The response of UsersApi->create_user_settings_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->create_user_settings_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
create_user_settings_permissions_request	CreateUserSettingsPermissionsRequest

Return type

GetUserSettingsPermissions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Updated user general settings returned	-

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

delete_user

User delete_user(user_id)

Delete user by ID

Deletes the user with the provided userId. Requires the MANAGE_USERS permission.

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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Delete user by ID
        api_response = api_instance.delete_user(user_id)
        print("The response of UsersApi->delete_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

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	User successfully deleted	-

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

delete_user_push_subscription

delete_user_push_subscription(user_id, endpoint)

Delete user push subscription by key

Deletes the user push subscription with the provided key.

Example

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

import seerr
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    endpoint = 'endpoint_example' # str | 

    try:
        # Delete user push subscription by key
        api_instance.delete_user_push_subscription(user_id, endpoint)
    except Exception as e:
        print("Exception when calling UsersApi->delete_user_push_subscription: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
endpoint	str

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successfully removed user push subscription	-

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

delete_user_settings_linked_accounts_jellyfin

delete_user_settings_linked_accounts_jellyfin(user_id)

Remove the linked Jellyfin account for a user

Removes the linked Jellyfin account for a specific user. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Remove the linked Jellyfin account for a user
        api_instance.delete_user_settings_linked_accounts_jellyfin(user_id)
    except Exception as e:
        print("Exception when calling UsersApi->delete_user_settings_linked_accounts_jellyfin: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Unlinking account succeeded	-
400	Unlink request invalid	-
404	User does not exist	-

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

delete_user_settings_linked_accounts_plex

delete_user_settings_linked_accounts_plex(user_id)

Remove the linked Plex account for a user

Removes the linked Plex account for a specific user. Requires MANAGE_USERS permission if editing other users.

Example

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

import seerr
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Remove the linked Plex account for a user
        api_instance.delete_user_settings_linked_accounts_plex(user_id)
    except Exception as e:
        print("Exception when calling UsersApi->delete_user_settings_linked_accounts_plex: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

void (empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Unlinking account succeeded	-
400	Unlink request invalid	-
404	User does not exist	-

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

get_user

GetUser2XXResponse get_user(take=take, skip=skip, sort=sort, sort_direction=sort_direction, q=q, include_ids=include_ids)

Get all users

Returns all users in a JSON object.

Example

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

import seerr
from seerr.models.get_user2_xx_response import GetUser2XXResponse
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.UsersApi(api_client)
    take = 20 # float |  (optional)
    skip = 0 # float |  (optional)
    sort = 'created' # str |  (optional) (default to 'created')
    sort_direction = 'sort_direction_example' # str | Sort direction. When omitted, the server chooses the direction per sort field (e.g. displayname defaults to asc, requests/updated to desc).  (optional)
    q = 'q_example' # str |  (optional)
    include_ids = 'include_ids_example' # str |  (optional)

    try:
        # Get all users
        api_response = api_instance.get_user(take=take, skip=skip, sort=sort, sort_direction=sort_direction, q=q, include_ids=include_ids)
        print("The response of UsersApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	float		[optional]
skip	float		[optional]
sort	str		[optional] [default to 'created']
sort_direction	str	Sort direction. When omitted, the server chooses the direction per sort field (e.g. displayname defaults to asc, requests/updated to desc).	[optional]
q	str		[optional]
include_ids	str		[optional]

Return type

GetUser2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	A JSON array of all users	-

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

get_user_by_user_id

User get_user_by_user_id(user_id)

Get user by ID

Retrieves user details in a JSON object. Requires the MANAGE_USERS permission.

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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get user by ID
        api_response = api_instance.get_user_by_user_id(user_id)
        print("The response of UsersApi->get_user_by_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_by_user_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

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	Users details in JSON	-

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

get_user_jellyfin_by_jellyfin_user_id

User get_user_jellyfin_by_jellyfin_user_id(jellyfin_user_id)

Get user by Jellyfin user ID

Retrieves user details by Jellyfin user ID in a JSON object. Returns filtered data based on the caller's permissions.

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.UsersApi(api_client)
    jellyfin_user_id = 'jellyfin_user_id_example' # str | The Jellyfin user ID (32-character hexadecimal string)

    try:
        # Get user by Jellyfin user ID
        api_response = api_instance.get_user_jellyfin_by_jellyfin_user_id(jellyfin_user_id)
        print("The response of UsersApi->get_user_jellyfin_by_jellyfin_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_jellyfin_by_jellyfin_user_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
jellyfin_user_id	str	The Jellyfin user ID (32-character hexadecimal string)

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
404	User not found	-
2XX	User details in JSON	-

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

get_user_push_subscription_by_endpoint

GetUserPushSubscriptions2XXResponse get_user_push_subscription_by_endpoint(user_id, endpoint)

Get web push notification settings for a user

Returns web push notification settings for a user in a JSON object.

Example

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

import seerr
from seerr.models.get_user_push_subscriptions2_xx_response import GetUserPushSubscriptions2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    endpoint = 'endpoint_example' # str | 

    try:
        # Get web push notification settings for a user
        api_response = api_instance.get_user_push_subscription_by_endpoint(user_id, endpoint)
        print("The response of UsersApi->get_user_push_subscription_by_endpoint:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_push_subscription_by_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
endpoint	str

Return type

GetUserPushSubscriptions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User web push notification settings in JSON	-

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

get_user_push_subscriptions

GetUserPushSubscriptions2XXResponse get_user_push_subscriptions(user_id)

Get all web push notification settings for a user

Returns all web push notification settings for a user in a JSON object.

Example

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

import seerr
from seerr.models.get_user_push_subscriptions2_xx_response import GetUserPushSubscriptions2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get all web push notification settings for a user
        api_response = api_instance.get_user_push_subscriptions(user_id)
        print("The response of UsersApi->get_user_push_subscriptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_push_subscriptions: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

GetUserPushSubscriptions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User web push notification settings in JSON	-

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

get_user_quota

GetUserQuota2XXResponse get_user_quota(user_id)

Get quotas for a specific user

Returns quota details for a user in a JSON object. Requires MANAGE_USERS permission if viewing other users.

Example

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

import seerr
from seerr.models.get_user_quota2_xx_response import GetUserQuota2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get quotas for a specific user
        api_response = api_instance.get_user_quota(user_id)
        print("The response of UsersApi->get_user_quota:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_quota: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

GetUserQuota2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User quota details in JSON	-

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

get_user_requests

GetUserRequests2XXResponse get_user_requests(user_id, take=take, skip=skip)

Get requests for a specific user

Retrieves a user's requests in a JSON object.

Example

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

import seerr
from seerr.models.get_user_requests2_xx_response import GetUserRequests2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    take = 20 # float |  (optional)
    skip = 0 # float |  (optional)

    try:
        # Get requests for a specific user
        api_response = api_instance.get_user_requests(user_id, take=take, skip=skip)
        print("The response of UsersApi->get_user_requests:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_requests: %s\n" % e)

Parameters

Name	Type	Notes
user_id	float
take	float	[optional]
skip	float	[optional]

Return type

GetUserRequests2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User's requests returned	-

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

get_user_settings_main

UserSettings get_user_settings_main(user_id)

Get general settings for a user

Returns general settings for a specific user. Requires MANAGE_USERS permission if viewing other users.

Example

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

import seerr
from seerr.models.user_settings import UserSettings
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get general settings for a user
        api_response = api_instance.get_user_settings_main(user_id)
        print("The response of UsersApi->get_user_settings_main:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_settings_main: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

UserSettings

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User general settings returned	-

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

get_user_settings_notifications

UserSettingsNotifications get_user_settings_notifications(user_id)

Get notification settings for a user

Returns notification settings for a specific user. Requires MANAGE_USERS permission if viewing other users.

Example

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

import seerr
from seerr.models.user_settings_notifications import UserSettingsNotifications
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get notification settings for a user
        api_response = api_instance.get_user_settings_notifications(user_id)
        print("The response of UsersApi->get_user_settings_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_settings_notifications: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

UserSettingsNotifications

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User notification settings returned	-

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

get_user_settings_password

GetUserSettingsPassword2XXResponse get_user_settings_password(user_id)

Get password page informatiom

Returns important data for the password page to function correctly. Requires MANAGE_USERS permission if viewing other users.

Example

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

import seerr
from seerr.models.get_user_settings_password2_xx_response import GetUserSettingsPassword2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get password page informatiom
        api_response = api_instance.get_user_settings_password(user_id)
        print("The response of UsersApi->get_user_settings_password:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_settings_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

GetUserSettingsPassword2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User password page information returned	-

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

get_user_settings_permissions

GetUserSettingsPermissions2XXResponse get_user_settings_permissions(user_id)

Get permission settings for a user

Returns permission settings for a specific user. Requires MANAGE_USERS permission if viewing other users.

Example

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

import seerr
from seerr.models.get_user_settings_permissions2_xx_response import GetUserSettingsPermissions2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get permission settings for a user
        api_response = api_instance.get_user_settings_permissions(user_id)
        print("The response of UsersApi->get_user_settings_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_settings_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

GetUserSettingsPermissions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	User permission settings returned	-

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

get_user_watch_data

GetUserWatchData2XXResponse get_user_watch_data(user_id)

Get watch data

Returns play count, play duration, and recently watched media.

Requires the ADMIN permission to fetch results for other users.

Example

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

import seerr
from seerr.models.get_user_watch_data2_xx_response import GetUserWatchData2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 

    try:
        # Get watch data
        api_response = api_instance.get_user_watch_data(user_id)
        print("The response of UsersApi->get_user_watch_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_watch_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float

Return type

GetUserWatchData2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Users	-

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

get_user_watchlist

GetUserWatchlist2XXResponse get_user_watchlist(user_id, page=page)

Get the Plex watchlist for a specific user

Retrieves a user's Plex Watchlist in a JSON object.

Example

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

import seerr
from seerr.models.get_user_watchlist2_xx_response import GetUserWatchlist2XXResponse
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.UsersApi(api_client)
    user_id = 3.4 # float | 
    page = 1 # float |  (optional) (default to 1)

    try:
        # Get the Plex watchlist for a specific user
        api_response = api_instance.get_user_watchlist(user_id, page=page)
        print("The response of UsersApi->get_user_watchlist:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_user_watchlist: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
page	float		[optional] [default to 1]

Return type

GetUserWatchlist2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Watchlist data returned	-

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

put_user

List[User] put_user(put_user_request)

Update batch of users

Update users with given IDs with provided values in request body.settings. You cannot update users' Plex tokens through this request.

Requires the MANAGE_USERS permission.

Example

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

import seerr
from seerr.models.put_user_request import PutUserRequest
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.UsersApi(api_client)
    put_user_request = seerr.PutUserRequest() # PutUserRequest | 

    try:
        # Update batch of users
        api_response = api_instance.put_user(put_user_request)
        print("The response of UsersApi->put_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->put_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
put_user_request	PutUserRequest

Return type

List[User]

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Successfully updated user details	-

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

update_user

User update_user(user_id, user)

Update a user by user ID

Update a user with the provided values. You cannot update a user's Plex token through this request.

Requires the MANAGE_USERS permission.

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.UsersApi(api_client)
    user_id = 3.4 # float | 
    user = seerr.User() # User | 

    try:
        # Update a user by user ID
        api_response = api_instance.update_user(user_id, user)
        print("The response of UsersApi->update_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	float
user	User

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Successfully updated user details	-

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

Uh oh!

FilesExpand file tree

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

seerr.UsersApi

create_auth_reset_password

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_auth_reset_password_by_guid

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_import_from_jellyfin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_import_from_plex

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_register_push_subscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_settings_linked_accounts_jellyfin

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_settings_linked_accounts_jellyfin_quickconnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_settings_linked_accounts_plex

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_settings_main

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_settings_notifications

Example