postiz_python_client.UserApi

All URIs are relative to http://localhost

Method	HTTP request	Description
users_controller_change_org	POST /user/change-org
users_controller_change_personal	POST /user/personal
users_controller_get_impersonate	GET /user/impersonate
users_controller_get_orgs	GET /user/organizations
users_controller_get_personal	GET /user/personal
users_controller_get_self	GET /user/self
users_controller_get_subscription	GET /user/subscription
users_controller_join_org	POST /user/join-org
users_controller_logout	POST /user/logout
users_controller_set_impersonate	POST /user/impersonate
users_controller_tiers	GET /user/subscription/tiers
users_controller_track_event	POST /user/t

users_controller_change_org

users_controller_change_org()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_change_org()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_change_org: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

users_controller_change_personal

users_controller_change_personal(body)

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)
    body = None # object | 

    try:
        api_instance.users_controller_change_personal(body)
    except Exception as e:
        print("Exception when calling UserApi->users_controller_change_personal: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

users_controller_get_impersonate

users_controller_get_impersonate(name)

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)
    name = 'name_example' # str | 

    try:
        api_instance.users_controller_get_impersonate(name)
    except Exception as e:
        print("Exception when calling UserApi->users_controller_get_impersonate: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_get_orgs

users_controller_get_orgs()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_get_orgs()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_get_orgs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_get_personal

users_controller_get_personal()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_get_personal()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_get_personal: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_get_self

users_controller_get_self()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_get_self()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_get_self: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_get_subscription

users_controller_get_subscription()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_get_subscription()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_get_subscription: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_join_org

users_controller_join_org()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_join_org()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_join_org: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

users_controller_logout

users_controller_logout()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_logout()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_logout: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

users_controller_set_impersonate

users_controller_set_impersonate()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_set_impersonate()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_set_impersonate: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

users_controller_tiers

users_controller_tiers()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_tiers()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_tiers: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

users_controller_track_event

users_controller_track_event()

Example

import postiz_python_client
from postiz_python_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 = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.UserApi(api_client)

    try:
        api_instance.users_controller_track_event()
    except Exception as e:
        print("Exception when calling UserApi->users_controller_track_event: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

FilesExpand file tree

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

postiz_python_client.UserApi

users_controller_change_org

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_change_personal

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_get_impersonate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_get_orgs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_get_personal

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_get_self

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_get_subscription

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_join_org

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_logout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_set_impersonate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

users_controller_tiers

Example

Parameters