madana_apiclient.UserServiceApi

All URIs are relative to http://api.madana.io/rest

Method	HTTP request	Description
cancel_subscription	POST /users/{username}/subscriptions/{planname}/cancel
create_object	POST /users	Creates a new user object.
delete_object	DELETE /users/{username}	Deletes an User based on the provided id and securitycontext.
delete_object_0	DELETE /users/{username}/social/{platform}/{ident}	Deletes linked account from the user and securitycontext.
get_avatars	GET /users/{username}/avatars
get_certificates	GET /users/{username}/certificates
get_enclave_history	GET /users/{username}/enclavehistory
get_object2	GET /users/{username}
set_avatar	POST /users/{username}/avatars
set_settings	POST /users/{username}/settings
update_object	PUT /users/{username}	Updates Userproperties based on the provided user object.

cancel_subscription

file_type cancel_subscription(planname, username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    planname = "planname_example" # str | 
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.cancel_subscription(planname, username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->cancel_subscription: %s\n" % e)

Parameters

Name	Type	Description	Notes
planname	str
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

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

create_object

file_type create_object()

Creates a new user object.

Creates a new user object

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from madana_apiclient.model.json_mdn_user import JsonMDNUser
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    referrer = "referrer_example" # str |  (optional)
    body = JsonMDNUser() # JsonMDNUser | provided user object inheriting properties and credentials (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Creates a new user object.
        api_response = api_instance.create_object(referrer=referrer, body=body)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->create_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
referrer	str		[optional]
body	JsonMDNUser	provided user object inheriting properties and credentials	[optional]

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	HTTP Response OK	-

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

delete_object

file_type delete_object(username)

Deletes an User based on the provided id and securitycontext.

Deletes an User based on the provided id and securitycontext

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Deletes an User based on the provided id and securitycontext.
        api_response = api_instance.delete_object(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->delete_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	HTTP Response OK	-

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

delete_object_0

file_type delete_object_0(ident, platform, username)

Deletes linked account from the user and securitycontext.

Deletes linked account from the user and securitycontext

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    ident = "ident_example" # str | 
    platform = "platform_example" # str | 
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Deletes linked account from the user and securitycontext.
        api_response = api_instance.delete_object_0(ident, platform, username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->delete_object_0: %s\n" % e)

Parameters

Name	Type	Description	Notes
ident	str
platform	str
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	HTTP Response OK	-

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

get_avatars

file_type get_avatars(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_avatars(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->get_avatars: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

get_certificates

file_type get_certificates(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_certificates(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->get_certificates: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

get_enclave_history

file_type get_enclave_history(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 
    limit = "30" # str |  (optional) if omitted the server will use the default value of "30"
    offset = "0" # str |  (optional) if omitted the server will use the default value of "0"

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_enclave_history(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->get_enclave_history: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.get_enclave_history(username, limit=limit, offset=offset)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->get_enclave_history: %s\n" % e)

Parameters

Name	Type	Notes
username	str
limit	str	[optional] if omitted the server will use the default value of "30"
offset	str	[optional] if omitted the server will use the default value of "0"

Return type

file_type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

get_object2

file_type get_object2(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.get_object2(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->get_object2: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

file_type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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

set_avatar

file_type set_avatar(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from madana_apiclient.model.json_mdn_user_profile_image import JsonMDNUserProfileImage
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 
    body = JsonMDNUserProfileImage(
        image="image_example",
        id="id_example",
    ) # JsonMDNUserProfileImage |  (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.set_avatar(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->set_avatar: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.set_avatar(username, body=body)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->set_avatar: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str
body	JsonMDNUserProfileImage		[optional]

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-

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

set_settings

file_type set_settings(username)

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from madana_apiclient.model.json_mdn_user_setting import JsonMDNUserSetting
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 
    body = JsonMDNUserSetting() # JsonMDNUserSetting |  (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.set_settings(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->set_settings: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.set_settings(username, body=body)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->set_settings: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str
body	JsonMDNUserSetting		[optional]

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-

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

update_object

file_type update_object(username)

Updates Userproperties based on the provided user object.

Updates Userproperties based on the provided user object

Example

import time
import madana_apiclient
from madana_apiclient.api import user_service_api
from madana_apiclient.model.json_mdn_user import JsonMDNUser
from pprint import pprint
# Defining the host is optional and defaults to http://api.madana.io/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = madana_apiclient.Configuration(
    host = "http://api.madana.io/rest"
)


# Enter a context with an instance of the API client
with madana_apiclient.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_service_api.UserServiceApi(api_client)
    username = "username_example" # str | 
    body = JsonMDNUser() # JsonMDNUser | the new user object inherting all properties that should be change (optional)

    # example passing only required values which don't have defaults set
    try:
        # Updates Userproperties based on the provided user object.
        api_response = api_instance.update_object(username)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->update_object: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Updates Userproperties based on the provided user object.
        api_response = api_instance.update_object(username, body=body)
        pprint(api_response)
    except madana_apiclient.ApiException as e:
        print("Exception when calling UserServiceApi->update_object: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str
body	JsonMDNUser	the new user object inherting all properties that should be change	[optional]

Return type

file_type

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	HTTP Response OK	-

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

Files

UserServiceApi.md

Latest commit

History

UserServiceApi.md

File metadata and controls

madana_apiclient.UserServiceApi

cancel_subscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_object

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_object

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_object_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_avatars

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_certificates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_enclave_history

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_object2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_avatar

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_settings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_object

Example

Parameters