Skip to content

Latest commit

 

History

History
419 lines (277 loc) · 12.6 KB

TenantServiceApi.md

File metadata and controls

419 lines (277 loc) · 12.6 KB

TenantServiceApi

All URIs are relative to http://localhost

Method Description
create_tenant Creates a new tenant.
disable_tenant Disables a tenant.
enable_tenant Disables a tenant.
get_tenant_by_id Retrieves a tenant by its unique identifier.
get_tenants Retrieves all Tenants with filters.
update_tenant Updates an existing tenant.

create_tenant

CreateTenantResponse create_tenant(create_tenant_request_with_user)

Creates a new tenant.

Example

import onelens_backend_client
from onelens_backend_client.models.create_tenant_request_with_user import CreateTenantRequestWithUser
from onelens_backend_client.models.create_tenant_response import CreateTenantResponse
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.TenantServiceApi(api_client)
    create_tenant_request_with_user = onelens_backend_client.CreateTenantRequestWithUser() # CreateTenantRequestWithUser | 

    try:
        # Creates a new tenant.
        api_response = api_instance.create_tenant(create_tenant_request_with_user)
        print("The response of TenantServiceApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantServiceApi->create_tenant: %s\n" % e)

Parameters

Name Type Description Notes
create_tenant_request_with_user CreateTenantRequestWithUser

Return type

CreateTenantResponse

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]

disable_tenant

object disable_tenant(set_tenant_status_request)

Disables a tenant.

Example

import onelens_backend_client
from onelens_backend_client.models.set_tenant_status_request import SetTenantStatusRequest
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.TenantServiceApi(api_client)
    set_tenant_status_request = onelens_backend_client.SetTenantStatusRequest() # SetTenantStatusRequest | 

    try:
        # Disables a tenant.
        api_response = api_instance.disable_tenant(set_tenant_status_request)
        print("The response of TenantServiceApi->disable_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantServiceApi->disable_tenant: %s\n" % e)

Parameters

Name Type Description Notes
set_tenant_status_request SetTenantStatusRequest

Return type

object

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

object enable_tenant(set_tenant_status_request)

Disables a tenant.

Example

import onelens_backend_client
from onelens_backend_client.models.set_tenant_status_request import SetTenantStatusRequest
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.TenantServiceApi(api_client)
    set_tenant_status_request = onelens_backend_client.SetTenantStatusRequest() # SetTenantStatusRequest | 

    try:
        # Disables a tenant.
        api_response = api_instance.enable_tenant(set_tenant_status_request)
        print("The response of TenantServiceApi->enable_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantServiceApi->enable_tenant: %s\n" % e)

Parameters

Name Type Description Notes
set_tenant_status_request SetTenantStatusRequest

Return type

object

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_by_id

GetTenantByIDResponse get_tenant_by_id(get_tenant_by_id_request)

Retrieves a tenant by its unique identifier.

Example

import onelens_backend_client
from onelens_backend_client.models.get_tenant_by_id_request import GetTenantByIDRequest
from onelens_backend_client.models.get_tenant_by_id_response import GetTenantByIDResponse
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.TenantServiceApi(api_client)
    get_tenant_by_id_request = onelens_backend_client.GetTenantByIDRequest() # GetTenantByIDRequest | 

    try:
        # Retrieves a tenant by its unique identifier.
        api_response = api_instance.get_tenant_by_id(get_tenant_by_id_request)
        print("The response of TenantServiceApi->get_tenant_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantServiceApi->get_tenant_by_id: %s\n" % e)

Parameters

Name Type Description Notes
get_tenant_by_id_request GetTenantByIDRequest

Return type

GetTenantByIDResponse

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_tenants

GetTenantsResponse get_tenants(get_tenants_request)

Retrieves all Tenants with filters.

Example

import onelens_backend_client
from onelens_backend_client.models.get_tenants_request import GetTenantsRequest
from onelens_backend_client.models.get_tenants_response import GetTenantsResponse
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.TenantServiceApi(api_client)
    get_tenants_request = onelens_backend_client.GetTenantsRequest() # GetTenantsRequest | 

    try:
        # Retrieves all Tenants with filters.
        api_response = api_instance.get_tenants(get_tenants_request)
        print("The response of TenantServiceApi->get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantServiceApi->get_tenants: %s\n" % e)

Parameters

Name Type Description Notes
get_tenants_request GetTenantsRequest

Return type

GetTenantsResponse

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

UpdateTenantResponse update_tenant(request)

Updates an existing tenant.

Example

import onelens_backend_client
from onelens_backend_client.models.update_tenant_response import UpdateTenantResponse
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.TenantServiceApi(api_client)
    request = 'request_example' # str | 

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

Parameters

Name Type Description Notes
request str

Return type

UpdateTenantResponse

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]