TenantUserServiceApi

All URIs are relative to http://localhost

Method	Description
create_tenant_user	Creates a new user.
create_tenant_user_from_ol_user_id	Creates a new user from onelens user id (ol_user_id).
disable_tenant_user	Disables an existing tenant user.
enable_tenant_user	Enables an existing tenant user.
enable_tenant_user_with_system	System Enables an existing tenant user.
get_tenant_user_by_ol_user_id	Retrieves a tenant user by its unique onelens user id (ol_user_id).
get_tenant_users	Retrieves all tenant users.
send_email_to_user_for_password_change	Sends a password change email to the user.
update_tenant_user	Updates an existing tenant user.
update_tenant_user_by_system	Updates tenant user by system.
update_tenant_user_details	Updates tenant user details.

create_tenant_user

CreateTenantUserResponse create_tenant_user(request)

Creates a new user.

Example

import onelens_backend_client
from onelens_backend_client.models.create_tenant_user_response import CreateTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    request = 'request_example' # str | 

    try:
        # Creates a new user.
        api_response = api_instance.create_tenant_user(request)
        print("The response of TenantUserServiceApi->create_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->create_tenant_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	str

Return type

CreateTenantUserResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

create_tenant_user_from_ol_user_id

CreateTenantUserResponse create_tenant_user_from_ol_user_id(request)

Creates a new user from onelens user id (ol_user_id).

Example

import onelens_backend_client
from onelens_backend_client.models.create_tenant_user_response import CreateTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    request = 'request_example' # str | 

    try:
        # Creates a new user from onelens user id (ol_user_id).
        api_response = api_instance.create_tenant_user_from_ol_user_id(request)
        print("The response of TenantUserServiceApi->create_tenant_user_from_ol_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->create_tenant_user_from_ol_user_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	str

Return type

CreateTenantUserResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

disable_tenant_user

DisableTenantUserResponse disable_tenant_user(disable_tenant_user_request)

Disables an existing tenant user.

Example

import onelens_backend_client
from onelens_backend_client.models.disable_tenant_user_request import DisableTenantUserRequest
from onelens_backend_client.models.disable_tenant_user_response import DisableTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    disable_tenant_user_request = onelens_backend_client.DisableTenantUserRequest() # DisableTenantUserRequest | 

    try:
        # Disables an existing tenant user.
        api_response = api_instance.disable_tenant_user(disable_tenant_user_request)
        print("The response of TenantUserServiceApi->disable_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->disable_tenant_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
disable_tenant_user_request	DisableTenantUserRequest

Return type

DisableTenantUserResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

enable_tenant_user

EnableTenantUserResponse enable_tenant_user(enable_tenant_user_request)

Enables an existing tenant user.

Example

import onelens_backend_client
from onelens_backend_client.models.enable_tenant_user_request import EnableTenantUserRequest
from onelens_backend_client.models.enable_tenant_user_response import EnableTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    enable_tenant_user_request = onelens_backend_client.EnableTenantUserRequest() # EnableTenantUserRequest | 

    try:
        # Enables an existing tenant user.
        api_response = api_instance.enable_tenant_user(enable_tenant_user_request)
        print("The response of TenantUserServiceApi->enable_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->enable_tenant_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
enable_tenant_user_request	EnableTenantUserRequest

Return type

EnableTenantUserResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

enable_tenant_user_with_system

EnableTenantUserResponse enable_tenant_user_with_system(enable_tenant_user_request)

System Enables an existing tenant user.

Example

import onelens_backend_client
from onelens_backend_client.models.enable_tenant_user_request import EnableTenantUserRequest
from onelens_backend_client.models.enable_tenant_user_response import EnableTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    enable_tenant_user_request = onelens_backend_client.EnableTenantUserRequest() # EnableTenantUserRequest | 

    try:
        # System Enables an existing tenant user.
        api_response = api_instance.enable_tenant_user_with_system(enable_tenant_user_request)
        print("The response of TenantUserServiceApi->enable_tenant_user_with_system:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->enable_tenant_user_with_system: %s\n" % e)

Parameters

Name	Type	Description	Notes
enable_tenant_user_request	EnableTenantUserRequest

Return type

EnableTenantUserResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_tenant_user_by_ol_user_id

GetTenantUserByIDResponse get_tenant_user_by_ol_user_id(get_tenant_user_by_id_request)

Retrieves a tenant user by its unique onelens user id (ol_user_id).

Example

import onelens_backend_client
from onelens_backend_client.models.get_tenant_user_by_id_request import GetTenantUserByIDRequest
from onelens_backend_client.models.get_tenant_user_by_id_response import GetTenantUserByIDResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    get_tenant_user_by_id_request = onelens_backend_client.GetTenantUserByIDRequest() # GetTenantUserByIDRequest | 

    try:
        # Retrieves a tenant user by its unique onelens user id (ol_user_id).
        api_response = api_instance.get_tenant_user_by_ol_user_id(get_tenant_user_by_id_request)
        print("The response of TenantUserServiceApi->get_tenant_user_by_ol_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->get_tenant_user_by_ol_user_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
get_tenant_user_by_id_request	GetTenantUserByIDRequest

Return type

GetTenantUserByIDResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_tenant_users

GetTenantUsersWithFilterResponse get_tenant_users(get_tenant_users_with_filter_request)

Retrieves all tenant users.

Example

import onelens_backend_client
from onelens_backend_client.models.get_tenant_users_with_filter_request import GetTenantUsersWithFilterRequest
from onelens_backend_client.models.get_tenant_users_with_filter_response import GetTenantUsersWithFilterResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    get_tenant_users_with_filter_request = onelens_backend_client.GetTenantUsersWithFilterRequest() # GetTenantUsersWithFilterRequest | 

    try:
        # Retrieves all tenant users.
        api_response = api_instance.get_tenant_users(get_tenant_users_with_filter_request)
        print("The response of TenantUserServiceApi->get_tenant_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->get_tenant_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
get_tenant_users_with_filter_request	GetTenantUsersWithFilterRequest

Return type

GetTenantUsersWithFilterResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

send_email_to_user_for_password_change

PasswordChangeEmailResponse send_email_to_user_for_password_change(password_change_email_request)

Sends a password change email to the user.

Example

import onelens_backend_client
from onelens_backend_client.models.password_change_email_request import PasswordChangeEmailRequest
from onelens_backend_client.models.password_change_email_response import PasswordChangeEmailResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    password_change_email_request = onelens_backend_client.PasswordChangeEmailRequest() # PasswordChangeEmailRequest | 

    try:
        # Sends a password change email to the user.
        api_response = api_instance.send_email_to_user_for_password_change(password_change_email_request)
        print("The response of TenantUserServiceApi->send_email_to_user_for_password_change:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->send_email_to_user_for_password_change: %s\n" % e)

Parameters

Name	Type	Description	Notes
password_change_email_request	PasswordChangeEmailRequest

Return type

PasswordChangeEmailResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

update_tenant_user

UpdateTenantUserResponse update_tenant_user(update_tenant_user_request)

Updates an existing tenant user.

Example

import onelens_backend_client
from onelens_backend_client.models.update_tenant_user_request import UpdateTenantUserRequest
from onelens_backend_client.models.update_tenant_user_response import UpdateTenantUserResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    update_tenant_user_request = onelens_backend_client.UpdateTenantUserRequest() # UpdateTenantUserRequest | 

    try:
        # Updates an existing tenant user.
        api_response = api_instance.update_tenant_user(update_tenant_user_request)
        print("The response of TenantUserServiceApi->update_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->update_tenant_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
update_tenant_user_request	UpdateTenantUserRequest

Return type

UpdateTenantUserResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

update_tenant_user_by_system

UpdateTenantUserBySystemResponse update_tenant_user_by_system(update_tenant_user_by_system_request)

Updates tenant user by system.

Example

import onelens_backend_client
from onelens_backend_client.models.update_tenant_user_by_system_request import UpdateTenantUserBySystemRequest
from onelens_backend_client.models.update_tenant_user_by_system_response import UpdateTenantUserBySystemResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    update_tenant_user_by_system_request = onelens_backend_client.UpdateTenantUserBySystemRequest() # UpdateTenantUserBySystemRequest | 

    try:
        # Updates tenant user by system.
        api_response = api_instance.update_tenant_user_by_system(update_tenant_user_by_system_request)
        print("The response of TenantUserServiceApi->update_tenant_user_by_system:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->update_tenant_user_by_system: %s\n" % e)

Parameters

Name	Type	Description	Notes
update_tenant_user_by_system_request	UpdateTenantUserBySystemRequest

Return type

UpdateTenantUserBySystemResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

update_tenant_user_details

UpdateTenantUserDetailsResponse update_tenant_user_details(update_tenant_user_details_request)

Updates tenant user details.

Example

import onelens_backend_client
from onelens_backend_client.models.update_tenant_user_details_request import UpdateTenantUserDetailsRequest
from onelens_backend_client.models.update_tenant_user_details_response import UpdateTenantUserDetailsResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.TenantUserServiceApi(api_client)
    update_tenant_user_details_request = onelens_backend_client.UpdateTenantUserDetailsRequest() # UpdateTenantUserDetailsRequest | 

    try:
        # Updates tenant user details.
        api_response = api_instance.update_tenant_user_details(update_tenant_user_details_request)
        print("The response of TenantUserServiceApi->update_tenant_user_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantUserServiceApi->update_tenant_user_details: %s\n" % e)

Parameters

Name	Type	Description	Notes
update_tenant_user_details_request	UpdateTenantUserDetailsRequest

Return type

UpdateTenantUserDetailsResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

Files

TenantUserServiceApi.md

Latest commit

History

TenantUserServiceApi.md

File metadata and controls

TenantUserServiceApi

create_tenant_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_tenant_user_from_ol_user_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

disable_tenant_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_tenant_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_tenant_user_with_system

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_tenant_user_by_ol_user_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_tenant_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

send_email_to_user_for_password_change

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_tenant_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_tenant_user_by_system

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_tenant_user_details

Example

Parameters