Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 3.26 KB

ModuleUserApi.md

File metadata and controls

89 lines (59 loc) · 3.26 KB
Raw

eZmaxApi.ModuleUserApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
user_create_ezsignuser_v1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser

user_create_ezsignuser_v1

UserCreateEzsignuserV1Response user_create_ezsignuser_v1(user_create_ezsignuser_v1_request)

Create a new User of type Ezsignuser

The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.user_create_ezsignuser_v1_request import UserCreateEzsignuserV1Request
from eZmaxApi.models.user_create_ezsignuser_v1_response import UserCreateEzsignuserV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ModuleUserApi(api_client)
    user_create_ezsignuser_v1_request = [eZmaxApi.UserCreateEzsignuserV1Request()] # List[UserCreateEzsignuserV1Request] | 

    try:
        # Create a new User of type Ezsignuser
        api_response = api_instance.user_create_ezsignuser_v1(user_create_ezsignuser_v1_request)
        print("The response of ModuleUserApi->user_create_ezsignuser_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ModuleUserApi->user_create_ezsignuser_v1: %s\n" % e)

Parameters

Name Type Description Notes
user_create_ezsignuser_v1_request List[UserCreateEzsignuserV1Request]

Return type

UserCreateEzsignuserV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -

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