embyapi.UserServiceApi

All URIs are relative to https://home.ourflix.de:32865/emby

Method	HTTP request	Description
delete_users_by_id	DELETE /Users/{Id}	Deletes a user
get_users	GET /Users	Gets a list of users
get_users_by_id	GET /Users/{Id}	Gets a user by Id
get_users_public	GET /Users/Public	Gets a list of publicly visible users for display on a login screen.
post_users_authenticatebyname	POST /Users/AuthenticateByName	Authenticates a user
post_users_by_id	POST /Users/{Id}	Updates a user
post_users_by_id_authenticate	POST /Users/{Id}/Authenticate	Authenticates a user
post_users_by_id_configuration	POST /Users/{Id}/Configuration	Updates a user configuration
post_users_by_id_easypassword	POST /Users/{Id}/EasyPassword	Updates a user's easy password
post_users_by_id_password	POST /Users/{Id}/Password	Updates a user's password
post_users_by_id_policy	POST /Users/{Id}/Policy	Updates a user policy
post_users_forgotpassword	POST /Users/ForgotPassword	Initiates the forgot password process for a local user
post_users_forgotpassword_pin	POST /Users/ForgotPassword/Pin	Redeems a forgot password pin
post_users_new	POST /Users/New	Creates a user

delete_users_by_id

delete_users_by_id(id)

Deletes a user

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Deletes a user
    api_instance.delete_users_by_id(id)
except ApiException as e:
    print("Exception when calling UserServiceApi->delete_users_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_users

list[UserDto] get_users(is_hidden=is_hidden, is_disabled=is_disabled)

Gets a list of users

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
is_hidden = true # bool | Optional filter by IsHidden=true or false (optional)
is_disabled = true # bool | Optional filter by IsDisabled=true or false (optional)

try:
    # Gets a list of users
    api_response = api_instance.get_users(is_hidden=is_hidden, is_disabled=is_disabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->get_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
is_hidden	bool	Optional filter by IsHidden=true or false	[optional]
is_disabled	bool	Optional filter by IsDisabled=true or false	[optional]

Return type

list[UserDto]

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

get_users_by_id

UserDto get_users_by_id(id)

Gets a user by Id

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Gets a user by Id
    api_response = api_instance.get_users_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->get_users_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

UserDto

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

get_users_public

list[UserDto] get_users_public()

Gets a list of publicly visible users for display on a login screen.

No authentication required

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = embyapi.UserServiceApi()

try:
    # Gets a list of publicly visible users for display on a login screen.
    api_response = api_instance.get_users_public()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->get_users_public: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[UserDto]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

post_users_authenticatebyname

AuthenticationAuthenticationResult post_users_authenticatebyname(body, x_emby_authorization)

Authenticates a user

Authenticate a user by nane and password. A 200 status code indicates success, while anything in the 400 or 500 range indicates failure --- No authentication required

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = embyapi.UserServiceApi()
body = embyapi.AuthenticateUserByName() # AuthenticateUserByName | AuthenticateUserByName
x_emby_authorization = 'x_emby_authorization_example' # str | The authorization header can be either named 'Authorization' or 'X-Emby-Authorization'.    It must be of the following schema:     Emby UserId=\"(guid)\", Client=\"(string)\", Device=\"(string)\", DeviceId=\"(string)\", Version=\"string\", Token=\"(string)\"     Please consult the documentation for further details.

try:
    # Authenticates a user
    api_response = api_instance.post_users_authenticatebyname(body, x_emby_authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_authenticatebyname: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	AuthenticateUserByName	AuthenticateUserByName
x_emby_authorization	str	The authorization header can be either named 'Authorization' or 'X-Emby-Authorization'. It must be of the following schema: Emby UserId="(guid)", Client="(string)", Device="(string)", DeviceId="(string)", Version="string", Token="(string)" Please consult the documentation for further details.

Return type

AuthenticationAuthenticationResult

Authorization

No authorization required

HTTP request headers

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

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

post_users_by_id

post_users_by_id(body, id)

Updates a user

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.UserDto() # UserDto | UserDto: 
id = 'id_example' # str | 

try:
    # Updates a user
    api_instance.post_users_by_id(body, id)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UserDto	UserDto:
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_users_by_id_authenticate

AuthenticationAuthenticationResult post_users_by_id_authenticate(body, id)

Authenticates a user

No authentication required

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = embyapi.UserServiceApi()
body = embyapi.AuthenticateUser() # AuthenticateUser | AuthenticateUser
id = 'id_example' # str | 

try:
    # Authenticates a user
    api_response = api_instance.post_users_by_id_authenticate(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id_authenticate: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	AuthenticateUser	AuthenticateUser
id	str

Return type

AuthenticationAuthenticationResult

Authorization

No authorization required

HTTP request headers

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

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

post_users_by_id_configuration

post_users_by_id_configuration(body, id)

Updates a user configuration

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.ConfigurationUserConfiguration() # ConfigurationUserConfiguration | UserConfiguration: 
id = 'id_example' # str | 

try:
    # Updates a user configuration
    api_instance.post_users_by_id_configuration(body, id)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ConfigurationUserConfiguration	UserConfiguration:
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_users_by_id_easypassword

post_users_by_id_easypassword(body, id)

Updates a user's easy password

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.UpdateUserEasyPassword() # UpdateUserEasyPassword | UpdateUserEasyPassword
id = 'id_example' # str | 

try:
    # Updates a user's easy password
    api_instance.post_users_by_id_easypassword(body, id)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id_easypassword: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UpdateUserEasyPassword	UpdateUserEasyPassword
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_users_by_id_password

post_users_by_id_password(body, id)

Updates a user's password

Requires authentication as user

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.UpdateUserPassword() # UpdateUserPassword | UpdateUserPassword
id = 'id_example' # str | 

try:
    # Updates a user's password
    api_instance.post_users_by_id_password(body, id)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UpdateUserPassword	UpdateUserPassword
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_users_by_id_policy

post_users_by_id_policy(body, id)

Updates a user policy

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.UsersUserPolicy() # UsersUserPolicy | UserPolicy: 
id = 'id_example' # str | 

try:
    # Updates a user policy
    api_instance.post_users_by_id_policy(body, id)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_by_id_policy: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UsersUserPolicy	UserPolicy:
id	str

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_users_forgotpassword

UsersForgotPasswordResult post_users_forgotpassword(body)

Initiates the forgot password process for a local user

No authentication required

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = embyapi.UserServiceApi()
body = embyapi.ForgotPassword() # ForgotPassword | ForgotPassword

try:
    # Initiates the forgot password process for a local user
    api_response = api_instance.post_users_forgotpassword(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_forgotpassword: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ForgotPassword	ForgotPassword

Return type

UsersForgotPasswordResult

Authorization

No authorization required

HTTP request headers

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

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

post_users_forgotpassword_pin

UsersPinRedeemResult post_users_forgotpassword_pin(body)

Redeems a forgot password pin

No authentication required

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = embyapi.UserServiceApi()
body = embyapi.ForgotPasswordPin() # ForgotPasswordPin | ForgotPasswordPin

try:
    # Redeems a forgot password pin
    api_response = api_instance.post_users_forgotpassword_pin(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_forgotpassword_pin: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ForgotPasswordPin	ForgotPasswordPin

Return type

UsersPinRedeemResult

Authorization

No authorization required

HTTP request headers

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

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

post_users_new

UserDto post_users_new(body)

Creates a user

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.UserServiceApi(embyapi.ApiClient(configuration))
body = embyapi.CreateUserByName() # CreateUserByName | CreateUserByName

try:
    # Creates a user
    api_response = api_instance.post_users_new(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserServiceApi->post_users_new: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	CreateUserByName	CreateUserByName

Return type

UserDto

Authorization

apikeyauth, embyauth

HTTP request headers

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

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

FilesExpand file tree

UserServiceApi.md

Latest commit

History

UserServiceApi.md

File metadata and controls

embyapi.UserServiceApi

delete_users_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_users

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_users_public

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_authenticatebyname

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id_authenticate

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id_easypassword

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id_password

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_by_id_policy

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_forgotpassword

Example

Parameters

Return type

Authorization

HTTP request headers

post_users_forgotpassword_pin