Skip to content

Latest commit

 

History

History
488 lines (310 loc) · 12.6 KB

AuthApi.md

File metadata and controls

488 lines (310 loc) · 12.6 KB

postiz_python_client.AuthApi

All URIs are relative to http://localhost

Method HTTP request Description
auth_controller_activate POST /auth/activate
auth_controller_can_register GET /auth/can-register
auth_controller_forgot POST /auth/forgot
auth_controller_forgot_return POST /auth/forgot-return
auth_controller_login POST /auth/login
auth_controller_oauth_exists POST /auth/oauth/{provider}/exists
auth_controller_oauth_link GET /auth/oauth/{provider}
auth_controller_register POST /auth/register

auth_controller_activate

auth_controller_activate()

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.AuthApi(api_client)

    try:
        api_instance.auth_controller_activate()
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_activate: %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]

auth_controller_can_register

auth_controller_can_register()

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.AuthApi(api_client)

    try:
        api_instance.auth_controller_can_register()
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_can_register: %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]

auth_controller_forgot

auth_controller_forgot(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.AuthApi(api_client)
    body = None # object | 

    try:
        api_instance.auth_controller_forgot(body)
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_forgot: %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]

auth_controller_forgot_return

auth_controller_forgot_return(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.AuthApi(api_client)
    body = None # object | 

    try:
        api_instance.auth_controller_forgot_return(body)
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_forgot_return: %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]

auth_controller_login

auth_controller_login(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.AuthApi(api_client)
    body = None # object | 

    try:
        api_instance.auth_controller_login(body)
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_login: %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]

auth_controller_oauth_exists

auth_controller_oauth_exists(provider)

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.AuthApi(api_client)
    provider = 'provider_example' # str | 

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

Parameters

Name Type Description Notes
provider 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
201 -

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

auth_controller_oauth_link

auth_controller_oauth_link(provider)

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.AuthApi(api_client)
    provider = 'provider_example' # str | 

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

Parameters

Name Type Description Notes
provider 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]

auth_controller_register

auth_controller_register(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.AuthApi(api_client)
    body = None # object | 

    try:
        api_instance.auth_controller_register(body)
    except Exception as e:
        print("Exception when calling AuthApi->auth_controller_register: %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]